pg_snippets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 519a6c52396cccfef3f45740313fc7905629e64c
+  data.tar.gz: fcd1d8ef5d0f12f2203d4c2ded4bf2d82949e048
+SHA512:
+  metadata.gz: 18e3fbc04179cc13a6d35bc2ab8bcc25180451bc96f911a47e7f3017fb1113c14735d79bc59b50728e4c02923caf63d7290fa20d455ca5ee6c06b5afb8e8067f
+  data.tar.gz: 48cdb0ec8bad0b802546c447172ac8d3380a6b4ef6f66b8ef91cd8d7144226cd74746c3764d03997e1ce50c5aefed084215ecd258d27a432aa0c958ac5a6392e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tylerhartland7@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tyler Hartland
+
+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,37 @@
+# PgSnippets
+
+Generate SQL to set up your PG database and tables
+
+## Usage
+
+```
+conn = PG::Connection.new(host: 'yourdbhost', user: 'yourdbuser', dbname: 'yourdbname')
+conn.exec(PgSnippets::V1.setup_db) # adds change id sequence and metadata function
+conn.exec('create table my_table(my_field1 serial primary key, my_field2 text')
+conn.exec(PgSnippets::V1.setup_table('my_table')) # adds created_at, updated_at, and change_id -- also uses hooks to keep them correctly updated
+
+### if using ActiveRecord, let the db handle metadata timestamps
+class MyTable
+  self.record_timestamps = false
+end
+```
+
+As long as you remember which change_id you saw last, you can always figure out which data in my_table has changed.
+
+The PgSnippets::V* namespace is to make sure the SQL never changes. Any changes to existing SQL will go into a new version namespace, so your migrations stay reproducible even if you upgrade this gem.
+
+## 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]/pg_snippets. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "pg_snippets"
+
+# 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/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/pg_snippets.rb

@@ -0,0 +1,4 @@
+require "pg_snippets/version"
+require "pg_snippets/v1"
+
+module PgSnippets; end

data/lib/pg_snippets/v1.rb

@@ -0,0 +1,56 @@
+module PgSnippets
+  module V1
+    class << self
+      CHANGE_ID  = 'change_id'
+      SEQUENCE   = "#{CHANGE_ID}_sequence"
+      UPDATED_AT = 'updated_at'
+      CREATED_AT = 'created_at'
+
+      def create_sequence(name=SEQUENCE)
+        "create sequence #{name};"
+      end
+
+      def create_update_metadata_function(change_column_name: CHANGE_ID, sequence_name: SEQUENCE, updated_at_column_name: UPDATED_AT, created_at_column_name: CREATED_AT)
+"create function update_metadata() returns trigger as $$
+begin
+  NEW.#{change_column_name} := nextval('#{sequence_name}');
+  NEW.#{updated_at_column_name} := now();
+  NEW.#{created_at_column_name} := now();
+  return NEW;
+end;
+$$  language plpgsql;"
+      end
+
+      def setup_db
+        create_sequence + create_update_metadata_function
+      end
+
+      def add_metadata_fields(table_name, change_column_name: CHANGE_ID, updated_at_column_name: UPDATED_AT, created_at_column_name: CREATED_AT)
+"alter table #{table_name}
+add column #{change_column_name} bigint
+,add column #{updated_at_column_name} timestamp
+,add column #{created_at_column_name} timestamp;"
+      end
+
+      def add_change_column_index(table_name, change_column_name: CHANGE_ID)
+"create index on #{table_name}(#{change_column_name});"
+      end
+
+      def add_suppress_redundant_updates_trigger(table_name)
+"create trigger z_suppress_redundant_updates_on_#{table_name}
+before update on #{table_name}
+for each row execute procedure suppress_redundant_updates_trigger();"
+      end
+
+      def add_update_metadata_trigger(table_name)
+"create trigger zz_update_metadata_on_#{table_name}
+before insert or update on #{table_name}
+for each row execute procedure update_metadata();"
+      end
+
+      def setup_table(table_name)
+        add_metadata_fields(table_name) + add_change_column_index(table_name) + add_suppress_redundant_updates_trigger(table_name) + add_update_metadata_trigger(table_name)
+      end
+    end
+  end
+end

data/lib/pg_snippets/version.rb

@@ -0,0 +1,3 @@
+module PgSnippets
+  VERSION = "0.0.1"
+end

data/pg_snippets.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_snippets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_snippets"
+  spec.version       = PgSnippets::VERSION
+  spec.authors       = ["Tyler Hartland"]
+  spec.email         = ["tylerhartland7@gmail.com"]
+
+  spec.summary       = 'A collection of Postgres data definition SQL builders'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pg"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pg_snippets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tyler Hartland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tylerhartland7@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/pg_snippets.rb
+- lib/pg_snippets/v1.rb
+- lib/pg_snippets/version.rb
+- pg_snippets.gemspec
+homepage: 
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A collection of Postgres data definition SQL builders
+test_files: []