pgtrigger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c03dcc06ecfb7b4b31108b9e980f7fd9b24b1e0
+  data.tar.gz: 675b4af5a537c2d3b2b2722ae54ac41ae69ac441
+SHA512:
+  metadata.gz: 5eb59a4784cc1df1ea7e740bbf67884f2165c1ed0ad63703ffda433a024504633bdb0f9e235b12800d566b213ef2a6d65d17a7a7710528992e1dc52e89ae3870
+  data.tar.gz: 8bfac53dd79dbda5c5feda8e265229c08ceb22b6634e9de8a75c6cc7f9bc48110ed43167f0b8959a7cfcd356cadc327bfcf17a204c2b405a70771e85709b5717

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andreluis88@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 André Alencar
+
+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

@@ -0,0 +1,72 @@
+# Pgtrigger
+
+Create trigger for postgres using ActiveRecord migration
+
+TODO:
+ - Create tests
+ - Create reversible method for create_trigger
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pgtrigger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pgtrigger
+
+## Usage
+
+Create a migration like this
+
+```ruby
+class AddTriggerToSomeTable < ActiveRecord::Migration[5.1]
+  def up
+    create_trigger(:table_name, :increase_order, before: [:insert]) do
+        <<-TRIGGERSQL
+            NEW."order" = (
+              SELECT COALESCE(MAX("order"), 0) +1
+              FROM table_name
+            );
+
+          RETURN NEW;
+        TRIGGERSQL
+    end
+  end
+
+  def down
+    remove_trigger(:tabloid_section_products, :increase_order)
+  end
+end
+```
+
+The create_trigger method, the first and second parameters are about table and name of trigger respectively.
+The third params can be hashes ```before:``` or ```after:```, passing string or array to indicate what event this trigger it will be executed.
+
+Yet is necessary to specify the down method, otherwise the trigger cannot be removed when execute migration rollback.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pgtrigger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+I appreciate new collaborators for this project.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pgtrigger project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alencarandre/pgtrigger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pgtrigger"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pgtrigger/active_record/migration.rb

@@ -0,0 +1,42 @@
+module ActiveRecord
+  class Migration
+    def create_trigger(table_name, trigger_name, after: nil, before: nil)
+      raise "Not defined after or before for create_trigger" unless after || before
+      raise "Define only on after or before" if after && before
+
+      trigger_name = Pgtrigger::Utils.build_trigger_name(table_name, trigger_name)
+
+      execute(<<-TRIGGERSQL
+          CREATE OR REPLACE FUNCTION #{trigger_name}_func()
+            RETURNS trigger
+            LANGUAGE plpgsql
+          AS $function$
+          BEGIN
+            #{yield}
+          END;
+          $function$
+        TRIGGERSQL
+      )
+
+      after = after.join(" OR ") if ["Array"].include?(after.class.to_s)
+      after = "AFTER #{after}" if after
+
+      before = before.join(" OR ") if ["Array"].include?(before.class.to_s)
+      before = "BEFORE #{before}" if before
+
+      execute(<<-TRIGGERSQL
+          CREATE TRIGGER #{trigger_name}_trigger
+            #{after} #{before} ON #{table_name}
+            FOR EACH ROW EXECUTE PROCEDURE #{trigger_name}_func()
+        TRIGGERSQL
+      )
+    end
+
+    def remove_trigger(table_name, trigger_name = nil)
+      trigger_name = Pgtrigger::Utils.build_trigger_name(table_name, trigger_name)
+
+      execute("DROP TRIGGER IF EXISTS #{trigger_name}_trigger ON #{table_name};")
+      execute("DROP FUNCTION IF EXISTS #{trigger_name}_func();")
+    end
+  end
+end

data/lib/pgtrigger/active_record/schema_dumper.rb

@@ -0,0 +1,83 @@
+module ActiveRecord
+  module SchemaDumperSupport
+    def trailer(stream)
+      triggers = mount_trigger_schema.join("")
+
+      if triggers.present?
+        if(@dump.respond_to?(:final))
+          @dump.final << triggers
+        else
+          stream.puts triggers
+        end
+      end
+
+      super(stream)
+    end
+
+    private
+
+    def mount_trigger_schema
+      triggers = []
+
+      discovery_triggers.each do |trigger|
+        table_name = trigger["event_object_table"]
+        trigger_name = trigger["trigger_name"].gsub("_#{table_name}_trigger", '')
+
+        after_or_before = "#{trigger['action_timing'].downcase}: \"#{trigger['event_manipulation']}\""
+
+        triggers << "\n"
+        triggers << "\tcreate_trigger \"#{table_name}\", \"#{trigger_name}\", #{after_or_before} do\n"
+        triggers << "<<-TRIGGERBODY\n"
+        triggers << parse_trigger_body(table_name, trigger_name)
+        triggers << "\nTRIGGERBODY\n"
+        triggers << "\tend # create_trigger"
+        triggers << "\n"
+      end
+
+      triggers
+    end
+
+    def discovery_triggers
+      sql = <<-DETECTTRIGGER
+        SELECT * FROM information_schema.triggers
+        WHERE trigger_schema = current_schema();
+      DETECTTRIGGER
+      result = @connection.execute(sql)
+    end
+
+    def parse_trigger_body(table_name, trigger_name)
+      procedure = discovery_trigger_method(table_name, trigger_name)
+      definition = procedure["definition"]
+      procedure_body = definition[definition.index("BEGIN")+5..definition.size]
+      procedure_body[0..procedure_body.rindex("END") -1].strip
+    end
+
+    def discovery_trigger_method(table_name, trigger_name)
+      sql = <<-DISCOVERYTRIGGERMETHOD
+            SELECT
+                n.nspname AS schema,
+                proname AS fname,
+                proargnames AS args,
+                t.typname AS return_type,
+                d.description,
+                pg_get_functiondef(p.oid) as definition
+            FROM pg_proc p
+            JOIN pg_type t
+              ON p.prorettype = t.oid
+            LEFT OUTER
+            JOIN pg_description d
+              ON p.oid = d.objoid
+            LEFT OUTER
+            JOIN pg_namespace n
+              ON n.oid = p.pronamespace
+           WHERE n.nspname = current_schema()
+             AND proname = '#{Pgtrigger::Utils.build_trigger_name(table_name, trigger_name)}_func'
+      DISCOVERYTRIGGERMETHOD
+      @connection.execute(sql).first
+    end
+  end
+
+  class SchemaDumper
+    prepend SchemaDumperSupport
+  end
+end

data/lib/pgtrigger/version.rb

@@ -0,0 +1,3 @@
+module Pgtrigger
+  VERSION = "0.1.1"
+end

data/lib/pgtrigger.rb

@@ -0,0 +1,11 @@
+require "pgtrigger/version"
+require "pgtrigger/active_record/migration"
+require "pgtrigger/active_record/schema_dumper"
+
+module Pgtrigger
+  class Utils
+    def self.build_trigger_name(table_name, trigger_name)
+      "#{trigger_name}_#{table_name}"
+    end
+  end
+end

data/pgtrigger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pgtrigger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pgtrigger"
+  spec.version       = Pgtrigger::VERSION
+  spec.authors       = ["André Alencar"]
+  spec.email         = ["andreluis88@gmail.com"]
+
+  spec.summary       = "Create Postgresql trigger with ActiveRecord Migration"
+  spec.description   = "Create Postgresql trigger with ActiveRecord Migration"
+  spec.homepage      = "https://github.com/alencarandre/pgtrigger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pgtrigger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- André Alencar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Create Postgresql trigger with ActiveRecord Migration
+email:
+- andreluis88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pgtrigger.rb
+- lib/pgtrigger/active_record/migration.rb
+- lib/pgtrigger/active_record/schema_dumper.rb
+- lib/pgtrigger/version.rb
+- pgtrigger.gemspec
+homepage: https://github.com/alencarandre/pgtrigger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Create Postgresql trigger with ActiveRecord Migration
+test_files: []