pg_inheritance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3454653b6ac4bb6e19903d97a2b11152633aa1144bb0cd20057d78a4a159d450
+  data.tar.gz: cb3b501bc727184aa24a9e6ad709393ce9176064e1b54c9b10067f1a5a63b174
+SHA512:
+  metadata.gz: a0949d2e040c91860a5af00bae171f5882b07ef217dce52b4d33533340368abee6eacbe0075e28d665e630d7cab4786c7c75b5b5d19b5043e1eeab240cc65fff
+  data.tar.gz: bf92d2c81ad011834e44fd14a04ce1334d2fade2205d3f2b31d714fdb87a0ad81df4772bbbf059ee2ed17bd71456537507313345d7bd6b929c46658f7ac720ca

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

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 rk@payappdigital.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,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pg_inheritance.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    pg_inheritance (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pg_inheritance!
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,41 @@
+# PG Inheritance
+[![Build Status](https://travis-ci.com/sigmen/pg_inheritance.svg?branch=master)](https://travis-ci.com/sigmen/pg_inheritance)
+
+# UNDER DEVELOPMENT
+
+### Supported ORM
+* ActiveRecord 6.0+
+
+### Migrations
+
+In your migration declare iherited_from option for create_table method call:
+
+```ruby
+class CreateMembers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+    end
+
+    create_table :members, inherited_from: :users do |t|
+      t.string :logo_url
+    end
+  end
+end
+```
+
+After migrations members has available both columns.
+
+### Drop inheritance
+
+In your migration call drop_inheritance method. This has no options.
+
+```ruby
+class DropMemberUsersInheritance < ActiveRecord::Migration
+  def change
+    drop_inheritance :members, :users
+  end
+end
+```
+
+If inheritance exists this will be undeclared, but columns at inherited table will still be available. Otherwise will be raised an exception.

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_inheritance'
+
+# 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/pg_inheritance/active_record/inheritable.rb

@@ -0,0 +1,37 @@
+module PGInheritance
+  module ActiveRecord
+    module Inheritable
+      def drop_inheritance(table_name, parent_name)
+        unless inherited?(table_name, parent_name)
+          raise PGInheritance::TableNotInheritedError, "#{table_name} not inherited from #{parent_name}"
+        end
+
+        execute(drop_inheritance_query(table_name, parent_name))
+      end
+
+      private
+
+      def inherited?(table_name, parent_name)
+        table_parents(table_name).any? { |x| x['relname'] == parent_name.to_s }
+      end
+
+      def table_parents(table_name)
+        execute(select_parents_query(table_name))
+      end
+
+      def drop_inheritance_query(table_name, parent_name)
+        "ALTER TABLE #{table_name} NO INHERIT #{parent_name};"
+      end
+
+      def select_parents_query(table_name)
+        <<-SQL
+          SELECT pg_namespace.nspname, pg_class.relname
+          FROM pg_catalog.pg_inherits
+            INNER JOIN pg_catalog.pg_class ON (pg_inherits.inhparent = pg_class.oid)
+            INNER JOIN pg_catalog.pg_namespace ON (pg_class.relnamespace = pg_namespace.oid)
+          WHERE inhrelid = '#{table_name}'::regclass
+        SQL
+      end
+    end
+  end
+end

data/lib/pg_inheritance/active_record/schema_statements.rb

@@ -0,0 +1,51 @@
+require 'pg_inheritance/active_record/inheritable'
+
+module PGInheritance
+  module ActiveRecord
+    module SchemaStatements
+      include PGInheritance::ActiveRecord::Inheritable
+
+      def create_table(table_name, options = {})
+        inherited_table = options.delete(:inherited_from)
+
+        prepare_options(inherited_table, options)
+
+        table_name = prepare_table_name(table_name, options)
+
+        super(table_name, options)
+      end
+
+      private
+
+      def prepare_options(inherited_table, options)
+        remove_pk_option(options)
+        add_inheritance_query(inherited_table, options)
+      end
+
+      def remove_pk_option(options)
+        return unless options[:inherited_from]
+
+        options[:id] = false
+        options.delete(:primary_key)
+      end
+
+      def add_inheritance_query(inherited_table, options)
+        return unless inherited_table
+
+        options[:options] = build_inherits_option(inherited_table)
+      end
+
+      def prepare_table_name(table_name, options)
+        schema = options.delete(:schema)
+
+        return table_name unless schema
+
+        "#{schema}.#{table_name}"
+      end
+
+      def build_inherits_option(inherited_table)
+        "INHERITS (#{inherited_table})"
+      end
+    end
+  end
+end

data/lib/pg_inheritance/railtie.rb

@@ -0,0 +1,13 @@
+require 'pg_inheritance/active_record/schema_statements'
+
+module PGInheritance
+  class Railtie < Rails::Railtie
+    initializer 'pg_inheritance' do
+      ActiveSupport.on_load(:active_record) do
+        adapter_klass = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+
+        adapter_klass.prepend(PGInheritance::ActiveRecord::SchemaStatements)
+      end
+    end
+  end
+end

data/lib/pg_inheritance/version.rb

@@ -0,0 +1,3 @@
+module PGInheritance
+  VERSION = '0.1.0'.freeze
+end

data/lib/pg_inheritance.rb

@@ -0,0 +1,6 @@
+require 'pg_inheritance/version'
+require 'pg_inheritance/railtie' if defined?(Rails::Railtie)
+
+module PGInheritance
+  class TableNotInheritedError < StandardError; end
+end

data/pg_inheritance.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'pg_inheritance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_inheritance'
+  spec.version       = PGInheritance::VERSION
+  spec.authors       = ['Roman Kakorin']
+  spec.email         = ['romchky1@gmail.com']
+
+  spec.summary       = 'Gem implements multitable iheritance.'
+  spec.description   = 'Gem implements multitable iheritance.'
+  spec.homepage      = 'https://github.com/sigmen/pg_inheritance'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'http://github.com/sigmen/pg_inheritance/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: pg_inheritance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Kakorin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: Gem implements multitable iheritance.
+email:
+- romchky1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_inheritance.rb
+- lib/pg_inheritance/active_record/inheritable.rb
+- lib/pg_inheritance/active_record/schema_statements.rb
+- lib/pg_inheritance/railtie.rb
+- lib/pg_inheritance/version.rb
+- pg_inheritance.gemspec
+homepage: https://github.com/sigmen/pg_inheritance
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sigmen/pg_inheritance
+  source_code_uri: https://github.com/sigmen/pg_inheritance
+  changelog_uri: http://github.com/sigmen/pg_inheritance/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Gem implements multitable iheritance.
+test_files: []