immigrate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04b07cc73ac791725c30dcdea4c1b9bb18ecd58d
+  data.tar.gz: bec1e61a6aabc9b7286c797ad93ec3a18aebb2c6
+SHA512:
+  metadata.gz: 0c3ad34bee19ce9bfebee81b8a7342c94ae9b61cb87255fa919e631e7757849d64f5965608cb1455613230aa0e92e5954fd597465a0fc478d9d2fc4fe8643672
+  data.tar.gz: 880ac56a20a6c927f8f5caa2c9e66203480fc22713b33a2dc8325dd3db9c823ede893fa60bd64a97808486eb4e87db94f6aa8eaf0c4c26d7c0f34881f5e6bd8d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+**/schema.rb
+*.log
+*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+addons:
+  postgresql: 9.4
+
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
+  - 2.0.0
+  - 1.9.3
+
+before_install: gem install bundler -v 1.11.2
+
+before_script:
+  (cd spec/dummy && bundle exec rake db:create)

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 brian.vanloo@pnmac.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 immigrate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brian VanLoo
+
+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,92 @@
+# Immigrate
+
+[![Build Status](https://travis-ci.org/ratdaddy/immigrate.svg?branch=master)](https://travis-ci.org/ratdaddy/immigrate)
+[![Code Climate](https://codeclimate.com/github/ratdaddy/immigrate/badges/gpa.svg)](https://codeclimate.com/github/ratdaddy/immigrate)
+
+Immigrate adds methods to `ActiveRecord::Migration` to create and manage [foreign-data wrappers](http://www.postgresql.org/docs/current/static/postgres-fdw.html) in PostgreSQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'immigrate'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+### Connecting to a Remote Server
+
+You will need to have a connection to a remote server before you can create a foreign table. This connection has to be created with connection information and user credentials for the foreign server in a `config/immigrate.yml` file:
+
+```yaml
+development:
+  foreign_server:
+    host: 192.83.123.89
+    port: 5432
+    dbname: foreign_db
+    user: foreign_user
+    password: password
+
+production:
+  foreign_server:
+    host: 192.83.123.90
+    port: 5432
+    dbname: foreign_db
+    user: foreign_user
+    password: password
+```
+
+Next you will need to create a migration to create the connection using a standard migration file like `db/migrate/[TIMESTAMP]_create_foreign_connection.rb:
+
+```ruby
+class CreateForeignConnection < ActiveRecord::Migration[5.0]
+  def change
+    create_foreign_connection :foreign_server
+  end
+end
+```
+
+Then you can run the migration as usual:
+
+```sh
+$ rake db:mibrate
+```
+
+Once you have a foreign connection you can now create migrations for the foreign tables you need to access in your application. This also goes in a standard migration file:
+
+```ruby
+class CreatePost < ActiveRecord::Migration[5.0]
+  def change
+    create_foreign_table :posts do |t|
+      t.string :title
+      t.text :body
+    end
+  end
+end
+```
+
+And once again you can run your migrations as usual:
+
+```sh
+$ rake db:mibrate
+```
+
+## 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/ratdaddy/immigrate. 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 'immigrate'
+
+# 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/immigrate.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'immigrate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'immigrate'
+  spec.version       = Immigrate::VERSION
+  spec.authors       = ['Brian VanLoo']
+  spec.email         = ['brian.vanloo@gmail.com']
+
+  spec.summary       = 'Support for PostgreSQL foreign data wrappers in Rails migrations'
+  spec.description   = 'Adds methods to ActiveRecord::Migration to create and manage foreign-data wrappers in PostgreSQL.'
+  spec.homepage      = 'https://github.com/ratdaddy/immigrate'
+  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_dependency 'railties', '>= 4.0.0'
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'pg'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'database_cleaner'
+end

data/lib/immigrate.rb

@@ -0,0 +1,10 @@
+require 'immigrate/version'
+require 'immigrate/railtie'
+require 'immigrate/foreign_table_definition'
+require 'immigrate/database'
+
+module Immigrate
+  def self.database
+    @@database ||= Database.new
+  end
+end

data/lib/immigrate/command_recorder.rb

@@ -0,0 +1,19 @@
+module Immigrate
+  module CommandRecorder
+    def create_foreign_connection *args
+      record(:create_foreign_connection, args)
+    end
+
+    def invert_create_foreign_connection *args
+      [:drop_foreign_connection, *args]
+    end
+
+    def create_foreign_table *args
+      record(:create_foreign_table, args)
+    end
+
+    def invert_create_foreign_table *args
+      [:drop_foreign_table, *args]
+    end
+  end
+end

data/lib/immigrate/database.rb

@@ -0,0 +1,47 @@
+module Immigrate
+  class Database
+    def create_fdw_extension
+      enable_extension :postgres_fdw
+    end
+
+    def drop_fdw_extension
+      disable_extension :postgres_fdw
+    end
+
+    def create_server_connection server
+      server_config = database_configuration[Rails.env][server.to_s]
+      execute <<-SQL
+        CREATE SERVER #{server}
+        FOREIGN DATA WRAPPER postgres_fdw
+        OPTIONS (host '#{server_config['host']}',
+                 port '#{server_config['port']}',
+                 dbname '#{server_config['dbname']}')
+      SQL
+    end
+
+    def create_user_mapping server
+      server_config = database_configuration[Rails.env][server.to_s]
+      execute <<-SQL
+        CREATE USER MAPPING FOR #{current_user}
+        SERVER #{server}
+        OPTIONS (user '#{server_config['user']}',
+                 password '#{server_config['password']}')
+      SQL
+    end
+
+    def current_user
+      execute("SELECT CURRENT_USER").first['current_user']
+    end
+
+    delegate :execute, :enable_extension, :disable_extension, to: :connection
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+
+    def database_configuration
+      yaml = Pathname.new('config/immigrate.yml')
+      YAML.load(ERB.new(yaml.read).result)
+    end
+  end
+end

data/lib/immigrate/foreign_table_definition.rb

@@ -0,0 +1,75 @@
+module Immigrate
+  class ForeignTableDefinition
+    NATIVE_DATABASE_TYPES = {
+      string:      'character varying',
+      text:        'text',
+      integer:     'integer',
+      float:       'float',
+      decimal:     'decimal',
+      datetime:    'timestamp',
+      time:        'time',
+      date:        'date',
+      daterange:   'daterange',
+      numrange:    'numrange',
+      tsrange:     'tsrange',
+      tstzrange:   'tstzrange',
+      int4range:   'int4range',
+      int8range:   'int8range',
+      binary:      'bytea',
+      boolean:     'boolean',
+      xml:         'xml',
+      tsvector:    'tsvector',
+      hstore:      'hstore',
+      inet:        'inet',
+      cidr:        'cidr',
+      macaddr:     'macaddr',
+      uuid:        'uuid',
+      json:        'json',
+      jsonb:       'jsonb',
+      ltree:       'ltree',
+      citext:      'citext',
+      point:       'point',
+      line:        'line',
+      lseg:        'lseg',
+      box:         'box',
+      path:        'path',
+      polygon:     'polygon',
+      circle:      'circle',
+      bit:         'bit',
+      bit_varying: 'bit varying',
+      money:       'money',
+    }
+
+    attr_reader :server, :name, :columns
+
+    def initialize name, server
+      @name = name
+      @server = server
+      @columns = []
+    end
+
+    def column name, type
+      @columns << [name, type]
+    end
+
+    NATIVE_DATABASE_TYPES.keys.each do |column_type|
+      module_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{column_type} name
+          column name, :#{column_type}
+        end
+      CODE
+    end
+
+    def sql
+      "CREATE FOREIGN TABLE #{name} (#{column_definitions}) SERVER #{server}"
+    end
+
+    def column_definitions
+      columns.map { |column| "#{column.first} #{native_column_type column.second}"}.join(',')
+    end
+
+    def native_column_type type
+      NATIVE_DATABASE_TYPES[type]
+    end
+  end
+end

data/lib/immigrate/loader.rb

@@ -0,0 +1,10 @@
+require 'immigrate/schema_statements'
+require 'immigrate/command_recorder'
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include Immigrate::SchemaStatements
+end
+
+class ActiveRecord::Migration::CommandRecorder
+  include Immigrate::CommandRecorder
+end

data/lib/immigrate/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module Immigrate
+  class Railtie < Rails::Railtie
+    initializer 'immigrate.load' do
+      ActiveSupport.on_load :active_record do
+        require 'immigrate/loader'
+      end
+    end
+  end
+end

data/lib/immigrate/schema_statements.rb

@@ -0,0 +1,34 @@
+module Immigrate
+  module SchemaStatements
+    def create_foreign_connection foreign_server
+      database.create_fdw_extension
+      database.create_server_connection foreign_server
+      database.create_user_mapping foreign_server
+    end
+
+    def drop_foreign_connection _foreign_server
+      database.drop_fdw_extension
+    end
+
+    def create_foreign_table foreign_table, foreign_server
+      fdw = create_foreign_table_definition(foreign_table, foreign_server)
+
+      yield fdw if block_given?
+
+      database.execute fdw.sql
+    end
+
+    def create_foreign_table_definition foreign_table, foreign_server
+      ForeignTableDefinition.new foreign_table, foreign_server
+    end
+
+    def drop_foreign_table foreign_table, _foreign_server = nil
+      database.execute "DROP FOREIGN TABLE #{foreign_table}"
+    end
+
+  private
+    def database
+      Immigrate.database
+    end
+  end
+end

data/lib/immigrate/version.rb

@@ -0,0 +1,3 @@
+module Immigrate
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: immigrate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian VanLoo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: Adds methods to ActiveRecord::Migration to create and manage foreign-data
+  wrappers in PostgreSQL.
+email:
+- brian.vanloo@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
+- immigrate.gemspec
+- lib/immigrate.rb
+- lib/immigrate/command_recorder.rb
+- lib/immigrate/database.rb
+- lib/immigrate/foreign_table_definition.rb
+- lib/immigrate/loader.rb
+- lib/immigrate/railtie.rb
+- lib/immigrate/schema_statements.rb
+- lib/immigrate/version.rb
+homepage: https://github.com/ratdaddy/immigrate
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Support for PostgreSQL foreign data wrappers in Rails migrations
+test_files: []
+has_rdoc: