fx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07cc76f1310a1982698708c2022bbfae7853263a
+  data.tar.gz: a598bd9efd102a6d8b2789379c46f865a4319f86
+SHA512:
+  metadata.gz: b9b0b8012f86bb96300811e6e7f3eaf0ae03f437da774bb8751759cd7c3546556d5bd3ed195410e97db0a808f55e118c88deca1887d570bd6752308aabd254b0
+  data.tar.gz: 022f693c2da994f7204e6320b4bf73b606df63d8d2c5a9f28bce6cb596d035ce949f2c39a3b6111aa6f926079a5b1b67ed73cd989b7ec1567aa5b3d2113a0e74

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,27 @@
+addons:
+  postgresql: "9.4"
+before_install:
+  - "echo '--colour' > ~/.rspec"
+  - "echo 'gem: --no-document' > ~/.gemrc"
+  - git config --global user.name "Travis CI"
+  - git config --global user.email "travis-ci@example.com"
+branches:
+  only:
+    - master
+install:
+  - travis_retry bin/setup
+language:
+  - ruby
+notifications:
+  email: false
+rvm:
+  - 2.3.1
+gemfile:
+  - gemfiles/rails40.gemfile
+  - gemfiles/rails41.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails50.gemfile
+matrix:
+  exclude:
+    - rvm: 2.1.8
+      gemfile: gemfiles/rails50.gemfile

data/.yardopts

@@ -0,0 +1,4 @@
+--hide-api private
+--exclude templates
+--markup markdown
+--markup-provider redcarpet

data/Appraisals

@@ -0,0 +1,21 @@
+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"
+end
+
+if RUBY_VERSION > "2.2.0"
+  appraise "rails50" do
+    gem "activerecord", "~> 5.0"
+    gem "railties", "~> 5.0"
+  end
+end

data/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+1. Fork the repository.
+2. Run `bin/setup`, which will install dependencies and create the dummy
+   application database.
+3. Run `bin/appraisal rake` to verify that the tests pass against all
+   supported versions of Rails.
+4. Make your change with new passing tests, following the existing style.
+5. Write a [good commit message], push your fork, and submit a pull request.
+
+[good commit message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Others will give constructive feedback.  This is a time for discussion and
+improvements, and making the necessary changes will be required before we can
+merge the contribution.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fx.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# F(x)
+
+F(x) adds methods to `ActiveRecord::Migration` to create and manage database
+functions and triggers in Rails.
+
+Using F(x), you can bring the power of SQL functions and triggers to your Rails
+application without having to switch your schema format to SQL. F(x) provides
+a convention for versioning functions and triggers that keeps your migration
+history consistent and reversible and avoids having to duplicate SQL strings
+across migrations. As an added bonus, you define the structure of your function
+in a SQL file, meaning you get full SQL syntax highlighting in the editor of
+your choice and can easily test your SQL in the database console during
+development.
+
+F(x) ships with support for PostgreSQL. The adapter is configurable (see
+`Fx::Configuration`) and has a minimal interface (see
+`Fx::Adapters::Postgres`) that other gems can provide.
+
+## Great, how do I create a trigger and a function?
+
+You've got this great idea for a trigger 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
+      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:
+
+```sql
+CREATE TRIGGER uppercase_users_name
+    BEFORE INSERT ON users
+    FOR EACH ROW
+    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.
+
+```sh
+% rake db:migrate
+```
+
+## Cool, but what if I need to change a trigger or function?
+
+Here's where F(x) really shines. Run that same function generator once more:
+
+```sh
+% rails generate fx:function uppercase_users_name
+      create  db/functions/uppercase_users_name_v02.sql
+      create  db/migrate/[TIMESTAMP]_update_function_uppercase_users_name_to_version_2.rb
+```
+
+F(x) detected that we already had an existing `uppercase_users_name` function at
+version 1, created a copy of that definition as version 2, and created a
+migration to update to the version 2 schema. All that's left for you to do is
+tweak the schema in the new definition and run the `update_function` migration.
+
+## I don't need this trigger or function anymore. Make it go away.
+
+F(x) gives you `drop_trigger` and `drop_function` too:
+
+```ruby
+def change
+  drop_function :uppercase_users_name, revert_to_version: 2
+end
+```

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+namespace :dummy do
+  require_relative "spec/dummy/config/application"
+  Dummy::Application.load_tasks
+end
+
+task(:spec).clear
+desc "Run specs other than spec/acceptance"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.exclude_pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run acceptance specs in spec/acceptance"
+RSpec::Core::RakeTask.new("spec:acceptance") do |task|
+  task.pattern = "spec/acceptance/**/*_spec.rb"
+  task.verbose = false
+end
+
+desc "Run the specs and acceptance tests"
+task default: %w(spec spec:acceptance)

data/bin/appraisal

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'appraisal' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appraisal", "appraisal")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+set -e
+
+gem install bundler --conservative
+bundle check || bundle install
+
+if [ -z "$CI" ]; then
+  bundle exec appraisal install
+fi
+
+bundle exec rake dummy:db:create

data/bin/yard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/fx.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fx"
+  spec.version       = Fx::VERSION
+  spec.authors       = ["Teo Ljungberg"]
+  spec.email         = ["teo@teoljungberg.com"]
+  spec.summary       = %q{Support for database functions and triggers in Rails migrations}
+  spec.description   = <<-DESCRIPTION
+    Adds methods to ActiveRecord::Migration to create and manage database functions
+    and triggers in Rails
+  DESCRIPTION
+  spec.homepage      = "https://github.com/teoljungberg/fx"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", '>= 1.5'
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '>= 3.3'
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "ammeter", '>= 1.1.3'
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+
+  spec.add_dependency "activerecord", '>= 4.0.0'
+  spec.add_dependency "railties", '>= 4.0.0'
+
+  spec.required_ruby_version = "~> 2.1"
+end

data/gemfiles/rails40.gemfile

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

data/gemfiles/rails40.gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: ../
+  specs:
+    fx (0.1.0)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+    activerecord (4.0.13)
+      activemodel (= 4.0.13)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.13)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.4)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    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 (4.0.2)
+    builder (3.1.4)
+    coderay (1.1.1)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.12.1)
+    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.0.13)
+      actionpack (= 4.0.13)
+      activesupport (= 4.0.13)
+      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 (0.3.49)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.0.0)
+  ammeter (>= 1.1.3)
+  appraisal
+  bundler (>= 1.5)
+  database_cleaner
+  fx!
+  pg
+  pry
+  railties (~> 4.0.0)
+  rake
+  redcarpet
+  rspec (>= 3.3)
+  yard
+
+BUNDLED WITH
+   1.12.4