antecedent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb8a23077c978e531dd2d3dce8283ede814f78f3
+  data.tar.gz: d999291bbddb20760175b4072fff75f2b2f467b4
+SHA512:
+  metadata.gz: cf78057b6c284066901da4a869dc5f8bc6026cb78f058ca10fc0ca2afbb0a753737b8a3aaec64d9854cb99083f48336ee2bf43a1165ff89782f8659f7bd8745f
+  data.tar.gz: f494b9f2a14f8e375fba42f055133483d27f28b5cf825350a71eb2a3dd2be22dca0cba264c6241f5ad929ec52b7b756c1992877f5212da6f8e600e2deb41a5f2

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in antecedent.gemspec
+gemspec
+
+group :test do
+  gem 'activerecord', '~> 5.2'
+  gem 'pg', '~> 1.0'
+  gem 'standalone_migrations', '~> 5.2', '>= 5.2.5'
+  gem 'database_cleaner', '~> 1.6', '>= 1.6.2'
+  gem 'factory_bot', '~> 4.8', '>= 4.8.2'
+  gem 'pry', '~> 0.11.3'
+end

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    antecedent (0.1.0)
+      activerecord (>= 4.2.7, < 5.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    database_cleaner (1.6.2)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    factory_bot (4.8.2)
+      activesupport (>= 3.0.0)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pg (1.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    standalone_migrations (5.2.5)
+      activerecord (>= 4.2.7, < 5.3.0)
+      railties (>= 4.2.7, < 5.3.0)
+      rake (>= 10.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  antecedent!
+  bundler (~> 1.16)
+  database_cleaner (~> 1.6, >= 1.6.2)
+  factory_bot (~> 4.8, >= 4.8.2)
+  pg (~> 1.0)
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  standalone_migrations (~> 5.2, >= 5.2.5)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Wontae Yang
+
+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,90 @@
+# Antecedent
+
+In some cases it is not desirable to retrieve STI
+classes in polymorphic relation and having scopes to
+filter by type column is good enough. (ex: I had to create
+a read only client API app that retrieves records
+from existing Rails DB). This gem was created to
+override default behavior of ActiveRecord
+`BelongsToPolymorphicAssociation`
+and return association in its base classes.
+
+It supports polymorphic type columns with base class names (ex: "User")
+and full class name (ex: "User::Admin").
+
+TODO: Add support for other AR versions (current version is only for 5.2)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'antecedent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install antecedent
+
+## Usage
+
+to disable entirely add following line in `config/initializers/antecedent.rb`:
+
+```
+Antecedent.disable_sti
+```
+
+using a wrapper method:
+
+```
+def without_sti
+  Antecedent.disable_sti
+  yield
+  Antecedent.enable_sti
+end
+
+without_sti do
+  #your code here
+end
+```
+
+to allow STI in some models while disabled, add following:
+
+```
+class User < ActiveRecord::Base
+  self.inheritance_column = :type
+end
+```
+
+## 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).
+
+## Test
+
+setup test db
+
+```
+rake db:setup db:migrate RAILS_ENV=test
+```
+
+run spec:
+
+```
+rspec .
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/antecedent.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'standalone_migrations'
+StandaloneMigrations::Tasks.load_tasks

data/antecedent.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "antecedent/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "antecedent"
+  spec.version       = Antecedent::VERSION
+  spec.authors       = ["Wontae Yang"]
+  spec.email         = ["wontaeyang@gmail.com"]
+
+  spec.summary       = %q{Override STI in polymorphic relation.}
+  spec.description   = %q{Sometimes, it is not desirable to retrieve STI models. This gem will allow relation to be returned in parent class.}
+  spec.homepage      = "https://github.com/wontaeyang/antecedent"
+  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.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  # Gem dependency
+  spec.add_dependency("activerecord", ["< 5.3.0", ">= 4.2.7"])
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "antecedent"
+
+# 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/db/config.yml

@@ -0,0 +1,9 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+test:
+  <<: *default
+  database: antecedent_test
+

data/db/migrate/20180410014636_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :type
+      t.integer :parent_id
+      t.string :parent_type
+    end
+  end
+end

data/db/schema.rb

@@ -0,0 +1,25 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2018_04_10_014636) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "users", force: :cascade do |t|
+    t.string "name"
+    t.string "type"
+    t.integer "parent_id"
+    t.string "parent_type"
+  end
+
+end

data/lib/antecedent.rb

@@ -0,0 +1,9 @@
+require "antecedent/version"
+require "active_record"
+
+if ActiveRecord::VERSION::STRING =~ /^5\./
+  require "antecedent/active_record_5"
+else
+  require "antecednt/fallback"
+end
+

data/lib/antecedent/active_record_5.rb

@@ -0,0 +1,36 @@
+module Antecedent
+  ASSOCIATION = ActiveRecord::Associations::BelongsToPolymorphicAssociation
+
+  def self.disable_sti
+    ASSOCIATION.class_eval do
+      alias _klass klass
+
+      def klass
+        type = owner[reflection.foreign_type]
+        type.presence && type_base_class(type)
+      end
+
+      private
+
+      def type_base_class(type)
+        type.constantize.base_class
+      rescue NameError
+        # if type class does not exist try
+        # removing namespace
+        type.deconstantize.constantize
+      end
+    end
+
+    ActiveRecord::Base.inheritance_column = :_type_disabled
+  end
+
+  def self.enable_sti
+    ASSOCIATION.class_eval do
+      if defined?(_klass)
+        alias klass _klass
+      end
+    end
+
+    ActiveRecord::Base.inheritance_column = :type
+  end
+end

data/lib/antecedent/fallback.rb

@@ -0,0 +1,19 @@
+module Antecedent
+  def self.disable_sti
+    raise_version_error
+  end
+
+  def self.enable_sti
+    raise_version_error
+  end
+
+  private
+
+  def self.raise_version_error
+    raise Antecedent::ActiveRecordVersionNotSupported.new(
+      "ActiveRecord version not supported"
+    )
+  end
+end
+
+class Antecedent::ActiveRecordVersionNotSupported < StandardError;end

data/lib/antecedent/version.rb

@@ -0,0 +1,3 @@
+module Antecedent
+  VERSION = "0.1.0"
+end

data/tags

@@ -0,0 +1,8 @@
+!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
+!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
+!_TAG_PROGRAM_NAME	Exuberant Ctags	//
+!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
+!_TAG_PROGRAM_VERSION	5.8	//
+Antecedent	lib/antecedent.rb	/^module Antecedent$/;"	m
+Antecedent	lib/antecedent/version.rb	/^module Antecedent$/;"	m

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: antecedent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wontae Yang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+description: Sometimes, it is not desirable to retrieve STI models. This gem will
+  allow relation to be returned in parent class.
+email:
+- wontaeyang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- antecedent.gemspec
+- bin/console
+- bin/setup
+- db/config.yml
+- db/migrate/20180410014636_create_users.rb
+- db/schema.rb
+- lib/antecedent.rb
+- lib/antecedent/active_record_5.rb
+- lib/antecedent/fallback.rb
+- lib/antecedent/version.rb
+- tags
+homepage: https://github.com/wontaeyang/antecedent
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Override STI in polymorphic relation.
+test_files: []