fx 0.3.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c933b484808a6a2a99f4a0faf84a20ea685f17bf
-  data.tar.gz: 6f38a705c1017b72f0930310f7a2dd9d3e273813
+SHA256:
+  metadata.gz: 1e391283922484cf5a5b06c7de944c3162a85b7b49546f1fd1a017a6fc762898
+  data.tar.gz: 73b179c85ebc70977bf4d2afbe45088284a9730138c2a424d940d72fb2ab0a30
 SHA512:
-  metadata.gz: '018b13261d9eabe7f6e79e36bcf4cf765956d409789d6d1c37255976c883a8f9fb4f4a2c5be960ebb283d5d436f9ea0e651309e635f531c0b74b9e88041cb6cd'
-  data.tar.gz: 12a8a67b11f91f717c75d4fe7a6a98b400501bf5f3914dc8088ecc8abf07ab2a08f45c012eba6578cd9f97cf32cf106a0add7db2fdfcc8d816e705cfcd445187
+  metadata.gz: 144fcbf71aad79383ee1ae98047b6fc018212ecd3ea2d747f883d7def2c649590b1d04fc77b0a84113fa832a6a0377857cf8482d2290c0c40f6496be0e6db470
+  data.tar.gz: 057f585e7e83a89aebfda256605813a7db9e7d01b5841f436be0a9f7323540fd5a49999e4bf3bbc6db33ab0342e4ad0727b1b9b16690ed3a1aea00ea3011ea2d

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/gemfiles/*.gemfile.lock
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/.travis.yml

@@ -1,5 +1,9 @@
 addons:
-  postgresql: "9.4"
+  postgresql: "10"
+  apt:
+    packages:
+    - postgresql-10
+    - postgresql-client-10
 before_install:
   - "echo '--colour' > ~/.rspec"
   - "echo 'gem: --no-document' > ~/.gemrc"
@@ -15,18 +19,21 @@ language:
 notifications:
   email: false
 rvm:
-  - 2.3.1
-  - 2.2.6
-  - 2.1.10
+  - 2.6
+  - 2.5
+  - 2.4
 gemfile:
-  - gemfiles/rails40.gemfile
-  - gemfiles/rails41.gemfile
   - gemfiles/rails42.gemfile
   - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
   - gemfiles/rails_edge.gemfile
 matrix:
   allow_failures:
     - gemfile: gemfiles/rails_edge.gemfile
   exclude:
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails50.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/rails_edge.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/rails60.gemfile

data/Appraisals

@@ -1,16 +1,7 @@
-appraise "rails40" do
-  gem "activerecord", "~> 4.0.0"
-  gem "railties", "~> 4.0.0"
-end
-
-appraise "rails41" do
-  gem "activerecord", "~> 4.1.0"
-  gem "railties", "~> 4.1.0"
-end
-
 appraise "rails42" do
   gem "activerecord", "~> 4.2.0"
   gem "railties", "~> 4.2.0"
+  gem "pg", "~> 0.15"
 end
 
 if RUBY_VERSION > "2.2.0"
@@ -19,6 +10,21 @@ if RUBY_VERSION > "2.2.0"
     gem "railties", "~> 5.0"
   end
 
+  appraise "rails51" do
+    gem "activerecord", "~> 5.1"
+    gem "railties", "~> 5.1"
+  end
+
+  appraise "rails52" do
+    gem "activerecord", "~> 5.2"
+    gem "railties", "~> 5.2"
+  end
+
+  appraise "rails60" do
+    gem "activerecord", "~> 6.0"
+    gem "railties", "~> 6.0"
+  end
+
   appraise "rails-edge" do
     gem "rails", github: "rails/rails"
     gem "arel", :github => "rails/arel"

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2016 Teo Ljungberg
+
+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

@@ -21,18 +21,29 @@ F(x) ships with support for PostgreSQL. The adapter is configurable (see
 
 ## Great, how do I create a trigger and a function?
 
-You've got this great idea for a trigger you'd like to call
+You've got this great idea for a function you'd like to call
 `uppercase_users_name`. You can create the migration and the corresponding
 definition file with the following command:
 
 ```sh
-% rails generate fx:trigger uppercase_users_name
+% rails generate fx:function uppercase_users_name
+      create  db/functions/uppercase_users_name_v01.sql
+      create  db/migrate/[TIMESTAMP]_create_function_uppercase_users_name.rb
+```
+
+Edit the `db/functions/uppercase_users_name_v01.sql` file with the SQL statement
+that defines your function.
+
+Next, let's add a trigger called `uppercase_users_name` to call our new
+function each time we `INSERT` on the `users` table.
+
+```sh
+% rails generate fx:trigger uppercase_users_name table_name:users
       create  db/triggers/uppercase_users_name_v01.sql
       create  db/migrate/[TIMESTAMP]_create_trigger_uppercase_users_name.rb
 ```
 
-Edit the `db/triggers/uppercase_users_name_v01.sql` file with the SQL statement
-that defines your trigger. In our example, this might look something like this:
+In our example, this might look something like this:
 
 ```sql
 CREATE TRIGGER uppercase_users_name
@@ -41,15 +52,6 @@ CREATE TRIGGER uppercase_users_name
     EXECUTE PROCEDURE uppercase_users_name();
 ```
 
-As you see, we execute a function called `uppercase_users_name` before each
-`INSERT` on the `users` table, which is a function we don't have yet.
-
-```sh
-% rails generate fx:function uppercase_users_name
-      create  db/functions/uppercase_users_name_v01.sql
-      create  db/migrate/[TIMESTAMP]_create_function_uppercase_users_name.rb
-```
-
 The generated migrations contains `create_function` and `create_trigger`
 statements. The migration is reversible and the schema will be dumped into your
 `schema.rb` file.
@@ -82,3 +84,30 @@ def change
   drop_function :uppercase_users_name, revert_to_version: 2
 end
 ```
+
+## What if I need to use a function as the default value of a column?
+
+You need to set F(x) to dump the functions in the beginning of db/schema.rb in a
+initializer:
+
+```ruby
+# config/initializers/fx.rb
+Fx.configure do |config|
+  config.dump_functions_at_beginning_of_schema = true
+end
+```
+
+And then you can use a lambda in your migration file:
+
+```ruby
+create_table :my_table do |t|
+  t.string :my_column, default: -> { "my_function()" }
+end
+```
+
+That's how you tell Rails to use the default as a literal SQL for the default
+column value instead of a plain string.
+
+## Contributing
+
+See [contributing](CONTRIBUTING.md) for more details.

data/fx.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activerecord", '>= 4.0.0'
   spec.add_dependency "railties", '>= 4.0.0'
 
-  spec.required_ruby_version = "~> 2.1"
+  spec.required_ruby_version = ">= 2.1"
 end

data/gemfiles/rails42.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.0"
 gem "railties", "~> 4.2.0"
+gem "pg", "~> 0.15"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.0"
 gem "railties", "~> 5.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails51.gemfile

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

data/gemfiles/rails52.gemfile

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

data/gemfiles/rails60.gemfile

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

data/gemfiles/rails_edge.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", :github => "rails/rails"
-gem "arel", :github => "rails/arel"
+gem "rails", github: "rails/rails"
+gem "arel", github: "rails/arel"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/fx.rb

@@ -7,10 +7,32 @@ require "fx/function"
 require "fx/statements"
 require "fx/schema_dumper"
 require "fx/trigger"
+require "fx/railtie"
 
 # F(x) adds methods `ActiveRecord::Migration` to create and manage database
 # triggers and functions in Rails applications.
 module Fx
+  # Hooks Fx into Rails.
+  #
+  # Enables fx migration methods, migration reversability, and `schema.rb`
+  # dumping.
+  def self.load
+    ActiveRecord::Migration::CommandRecorder.send(
+      :include,
+      Fx::CommandRecorder,
+    )
+
+    ActiveRecord::SchemaDumper.send(
+      :prepend,
+      Fx::SchemaDumper,
+    )
+
+    ActiveRecord::ConnectionAdapters::AbstractAdapter.send(
+      :include,
+      Fx::Statements,
+    )
+  end
+
   # The current database adapter used by F(x).
   #
   # This defaults to {Fx::Adapters::Postgres} but can be overridden

data/lib/fx/adapters/postgres.rb

@@ -125,7 +125,11 @@ module Fx
       #
       # @return [void]
       def drop_function(name)
-        execute "DROP FUNCTION #{name}();"
+        if support_drop_function_without_args
+          execute "DROP FUNCTION #{name};"
+        else
+          execute "DROP FUNCTION #{name}();"
+        end
       end
 
       # Drops the trigger from the database
@@ -150,6 +154,14 @@ module Fx
       def connection
         Connection.new(connectable.connection)
       end
+
+      def support_drop_function_without_args
+        # https://www.postgresql.org/docs/9.6/sql-dropfunction.html
+        # https://www.postgresql.org/docs/10/sql-dropfunction.html
+
+        pg_connection = connectable.connection.raw_connection
+        pg_connection.server_version >= 10_00_00
+      end
     end
   end
 end

data/lib/fx/adapters/postgres/functions.rb

@@ -17,7 +17,10 @@ module Fx
               ON pn.oid = pp.pronamespace
           LEFT JOIN pg_depend pd
               ON pd.objid = pp.oid AND pd.deptype = 'e'
+          LEFT JOIN pg_aggregate pa
+              ON pa.aggfnoid = pp.oid
           WHERE pn.nspname = 'public' AND pd.objid IS NULL
+              AND pa.aggfnoid IS NULL
           ORDER BY pp.oid;
         EOS
 

data/lib/fx/command_recorder.rb

@@ -22,8 +22,3 @@ module Fx
     end
   end
 end
-
-ActiveRecord::Migration::CommandRecorder.send(
-  :include,
-  Fx::CommandRecorder,
-)

data/lib/fx/configuration.rb

@@ -17,6 +17,7 @@ module Fx
   # ```
   # Fx.configure do |config|
   #   config.database = Fx::Adapters::Postgres
+  #   config.dump_functions_at_beginning_of_schema = true
   # end
   # ```
   def self.configure
@@ -31,8 +32,17 @@ module Fx
     # @return Fx adapter
     attr_accessor :database
 
+    # Prioritizes the order in the schema.rb of functions before other
+    # statements in order to make directly schema load work when using functions
+    # in statements below, i.e.: default column values.
+    #
+    # Defaults to false
+    # @return Boolean
+    attr_accessor :dump_functions_at_beginning_of_schema
+
     def initialize
       @database = Fx::Adapters::Postgres.new
+      @dump_functions_at_beginning_of_schema = false
     end
   end
 end

data/lib/fx/definition.rb

@@ -8,7 +8,7 @@ module Fx
     end
 
     def to_sql
-      File.read(full_path).tap do |content|
+      File.read(find_file || full_path).tap do |content|
         if content.empty?
           raise "Define #{@type} in #{path} before migrating."
         end
@@ -20,7 +20,7 @@ module Fx
     end
 
     def path
-      File.join("db", @type.pluralize, filename)
+      @_path ||= File.join("db", @type.pluralize, filename)
     end
 
     def version
@@ -30,7 +30,17 @@ module Fx
     private
 
     def filename
-      "#{@name}_v#{version}.sql"
+      @_filename ||= "#{@name}_v#{version}.sql"
+    end
+
+    def find_file
+      migration_paths.lazy
+        .map { |migration_path| File.expand_path(File.join("..", "..", path), migration_path) }
+        .find { |definition_path| File.exist?(definition_path) }
+    end
+
+    def migration_paths
+      Rails.application.config.paths["db/migrate"].expanded
     end
   end
 end

data/lib/fx/railtie.rb

@@ -0,0 +1,15 @@
+require "rails/railtie"
+
+module Fx
+  # Automatically initializes Fx in the context of a Rails application when
+  # ActiveRecord is loaded.
+  #
+  # @see Fx.load
+  class Railtie < Rails::Railtie
+    initializer "fx.load" do
+      ActiveSupport.on_load :active_record do
+        Fx.load
+      end
+    end
+  end
+end

data/lib/fx/schema_dumper.rb

@@ -8,8 +8,3 @@ module Fx
     include Trigger
   end
 end
-
-ActiveRecord::SchemaDumper.send(
-  :prepend,
-  Fx::SchemaDumper,
-)

data/lib/fx/schema_dumper/function.rb

@@ -5,15 +5,24 @@ module Fx
     # @api private
     module Function
       def tables(stream)
+        if Fx.configuration.dump_functions_at_beginning_of_schema
+          functions(stream)
+          empty_line(stream)
+        end
+
         super
-        functions(stream)
-      end
 
-      def functions(stream)
-        if dumpable_functions_in_database.any?
-          stream.puts
+        unless Fx.configuration.dump_functions_at_beginning_of_schema
+          functions(stream)
+          empty_line(stream)
         end
+      end
+
+      def empty_line(stream)
+        stream.puts if dumpable_functions_in_database.any?
+      end
 
+      def functions(stream)
         dumpable_functions_in_database.each do |function|
           stream.puts(function.to_schema)
         end