activerecord-chemistry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28286abd968e52e11339892d89633afdf8ecfabf
+  data.tar.gz: bc470a17de74b6026d458a335c92bd92bcb03a29
+SHA512:
+  metadata.gz: 42d8e0687dfd55185099ada2b552b32cdb7015530ae032e234fddaf18218af4abdc4a554c2f28e8b85033c5cc326be695dd8def003098d8036274b87fa6cb624
+  data.tar.gz: f00f843c8d4bd6314c3cc70a8922ffb0832d6b588431215845e75405e9cc708a3d8286708e67f90fe1779fa901f9f6cd97b8ce16c9530bb71dc169b239a3ba45

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.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 thom@thombruce.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 inheritance.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    activerecord-chemistry (0.1.0)
+      activerecord (>= 5.1)
+      activesupport (>= 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    ast (2.3.0)
+    concurrent-ruby (1.0.5)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    i18n (0.8.6)
+    json (2.1.0)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    sqlite3 (1.3.13)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.15.0)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-chemistry!
+  bundler (~> 1.14)
+  coveralls (~> 0.8)
+  factory_girl (~> 4.8.0)
+  rake (~> 12.0)
+  rspec (~> 3)
+  rubocop (~> 0.49.1)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Thom Bruce
+
+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,42 @@
+# ActiveRecord::Chemistry
+
+[![CircleCI](https://img.shields.io/circleci/project/github/thombruce/activerecord-chemistry.svg)](https://circleci.com/gh/thombruce/activerecord-chemistry) [![Coveralls](https://img.shields.io/coveralls/thombruce/activerecord-chemistry.svg)](https://coveralls.io/github/thombruce/activerecord-chemistry) [![Gemnasium](https://img.shields.io/gemnasium/thombruce/activerecord-chemistry.svg)](https://gemnasium.com/github.com/thombruce/activerecord-chemistry) [![Code Climate](https://img.shields.io/codeclimate/github/thombruce/activerecord-chemistry.svg)](https://codeclimate.com/github/thombruce/activerecord-chemistry) [![Beerpay](https://beerpay.io/thombruce/activerecord-chemistry/badge.svg?style=beer)](https://beerpay.io/thombruce/activerecord-chemistry)
+
+
+Based on and inspired by [ActiveRecord::ActsAs](https://github.com/krautcomputing/active_record-acts_as). For simple multiple table inheritance, use that. ActiveRecord::Chemistry adds more complex relationships and aims to enforce referential integrity.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-chemistry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-chemistry
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/thombruce/activerecord-chemistry. 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/activerecord-chemistry.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/chemistry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-chemistry"
+  spec.version       = ActiveRecord::Chemistry::VERSION
+  spec.authors       = ["Thom Bruce"]
+  spec.email         = ["thom@thombruce.com"]
+
+  spec.summary       = %q{Adds inheritance logic for Rails ActiveRecord.}
+  spec.description   = %q{Adds several different inheritance patterns for use with Rails models and ActiveRecord relations.}
+  spec.homepage      = "http://github.com/thombruce/activerecord-chemistry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.required_ruby_version = ">= 2.4"
+  
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "factory_girl", "~> 4.8.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "rubocop", "~> 0.49.1"
+  
+  spec.add_dependency "activesupport", ">= 5.1"
+  spec.add_dependency "activerecord", ">= 5.1"
+end

data/bin/console

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

@@ -0,0 +1,3 @@
+database:
+  override:
+    - echo "Skipping database."

data/lib/activerecord/chemistry/actable/instance_methods.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Chemistry
+    module Actable
+      module InstanceMethods
+        def actable_must_be_valid
+          unless acting_as.valid?
+            acting_as.errors.each do |attribute, message|
+              errors.add(attribute, message) unless errors[attribute].include?(message)
+            end
+          end
+        end
+        protected :actable_must_be_valid
+
+        def respond_to?(name, include_private = false, as_original_class = false)
+          if as_original_class
+            super(name, include_private)
+          else
+            super(name, include_private) || acting_as.respond_to?(name)
+          end
+        end
+
+        def self_respond_to?(name, include_private = false)
+          respond_to? name, include_private, true
+        end
+
+        def method_missing(method, *args, &block)
+          if !self_respond_to?(method) && acting_as.respond_to?(method)
+            acting_as.send(method, *args, &block)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/actable/migration.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module Chemistry
+    module Actable
+      module Migration
+        module TableDefinition
+          def acts_as(*args)
+            options = args.extract_options!
+            args.each do |col|
+              references(col, options)
+            end
+          end
+        end
+
+        module Table
+          include TableDefinition
+
+          def remove_acts_as(*args)
+            options = args.extract_options!
+            args.each do |col|
+              @base.remove_reference(@name, col, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/actable/relation.rb

@@ -0,0 +1,39 @@
+require 'activerecord/chemistry/actable/instance_methods'
+
+module ActiveRecord
+  module Chemistry
+    module Actable
+      module Relation
+        extend ActiveSupport::Concern
+
+        included do
+        end
+
+        class_methods do
+          def acts_as(name, scope = nil, options = {})
+            if Hash === scope
+              options = scope
+              scope = nil
+            end
+            options[:dependent] ||= :destroy
+            reflections = belongs_to(name, scope, options)
+            default_scope -> { includes(name) }
+            validate :actable_must_be_valid
+
+            cattr_reader(:acting_as_reflection) { reflections.stringify_keys[name.to_s] }
+            cattr_reader(:acting_as_model) { (options[:class_name] || name.to_s.camelize).constantize }
+            class_eval "def #{name}; super || build_#{name}(acting_as_model.actable_reflection.name => self); end"
+            alias_method :acting_as, name
+            alias_method :acting_as=, "#{name}=".to_sym
+            include Actable::InstanceMethods
+          end
+
+          def actable(name, scope = nil, options = {})
+            reflections = has_one(name, scope, options.merge(dependent: :destroy))
+            cattr_reader(:actable_reflection) { reflections.stringify_keys[name.to_s] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/actable.rb

@@ -0,0 +1,11 @@
+require 'activerecord/chemistry/actable/migration'
+require 'activerecord/chemistry/actable/relation'
+
+module ActiveRecord
+  module Chemistry
+    module Actable
+      include ActiveRecord::Chemistry::Actable::Migration
+      include ActiveRecord::Chemistry::Actable::Relation
+    end
+  end
+end

data/lib/activerecord/chemistry/extendable/instance_methods.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Chemistry
+    module Extendable
+      module InstanceMethods
+        def extendable_must_be_valid
+          unless extendable.valid?
+            extendable.errors.each do |attribute, message|
+              errors.add(attribute, message) unless errors[attribute].include?(message)
+            end
+          end
+        end
+        protected :extendable_must_be_valid
+
+        def respond_to?(name, include_private = false, as_original_class = false)
+          if as_original_class
+            super(name, include_private)
+          else
+            super(name, include_private) || extendable.respond_to?(name)
+          end
+        end
+
+        def self_respond_to?(name, include_private = false)
+          respond_to? name, include_private, true
+        end
+
+        def method_missing(method, *args, &block)
+          if !self_respond_to?(method) && extendable.respond_to?(method)
+            extendable.send(method, *args, &block)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/extendable/migration.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module Chemistry
+    module Extendable
+      module Migration
+        module TableDefinition
+          def extended_by(*args)
+            options = args.extract_options!
+            args.each do |col|
+              references(col, options)
+            end
+          end
+        end
+
+        module Table
+          include TableDefinition
+
+          def remove_extended_by(*args)
+            options = args.extract_options!
+            args.each do |col|
+              @base.remove_reference(@name, col, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/extendable/relation.rb

@@ -0,0 +1,36 @@
+require 'activerecord/chemistry/extendable/instance_methods'
+
+module ActiveRecord
+  module Chemistry
+    module Extendable
+      module Relation
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def extendable_by(name, scope = nil, options = {})
+            reflections = belongs_to(name, scope, options.merge(dependent: :destroy, optional: true))
+            cattr_reader(:extended_by_reflection) { reflections.stringify_keys[name.to_s] }
+          end
+
+          def extends(name, scope = nil, options = {})
+            if Hash === scope
+              options = scope
+              scope = nil
+            end
+            options[:dependent] ||= :nullify
+            reflections = has_one(name, scope, options)
+            default_scope -> { includes(name) }
+            validate :extendable_must_be_valid
+
+            cattr_reader(:extendable_reflection) { reflections.stringify_keys[name.to_s] }
+            cattr_reader(:extendable_model) { (options[:class_name] || name.to_s.camelize).constantize }
+            class_eval "def #{name}; super || build_#{name}(extendable_model.extended_by_reflection.name => self); end"
+            alias_method :extendable, name
+            alias_method :extendable=, "#{name}=".to_sym
+            include Extendable::InstanceMethods
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/extendable.rb

@@ -0,0 +1,11 @@
+require 'activerecord/chemistry/extendable/migration'
+require 'activerecord/chemistry/extendable/relation'
+
+module ActiveRecord
+  module Chemistry
+    module Extendable
+      include ActiveRecord::Chemistry::Extendable::Migration
+      include ActiveRecord::Chemistry::Extendable::Relation
+    end
+  end
+end

data/lib/activerecord/chemistry/representable/class_methods.rb

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module Chemistry
+    module Representable
+      module ClassMethods
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/representable/instance_methods.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module Chemistry
+    module Representable
+      module InstanceMethods
+        def representable_must_be_valid
+          unless representing.valid?
+            representing.errors.each do |attribute, message|
+              errors.add(attribute, message) unless errors[attribute].include?(message)
+            end
+          end
+        end
+        protected :representable_must_be_valid
+
+        def find_by_or_keep_representable
+          if representing.new_record? && @findable = representing_model.find_by(self.representing.attributes.reject { |k| ['id', 'created_at', 'updated_at'].include? k })
+            self.representing = @findable
+            #@findable.association(representing_model.representable_reflection.name.to_sym).add_to_target(self, true)
+          end
+        end
+
+        def update_or_instantiate_representable
+          if representing.changed? && representing.send(representing_model.representable_reflection.name.to_sym).count > 1
+            self.representing = representing.dup
+          end
+        end
+
+        def respond_to?(name, include_private = false, as_original_class = false)
+          if as_original_class
+            super(name, include_private)
+          else
+            super(name, include_private) || representing.respond_to?(name)
+          end
+        end
+
+        def self_respond_to?(name, include_private = false)
+          respond_to? name, include_private, true
+        end
+
+        def method_missing(method, *args, &block)
+          if !self_respond_to?(method) && representing.respond_to?(method)
+            representing.send(method, *args, &block)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/representable/migration.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module Chemistry
+    module Representable
+      module Migration
+        module TableDefinition
+          def represents(*args)
+            options = args.extract_options!
+            args.each do |col|
+              references(col, options)
+            end
+          end
+        end
+
+        module Table
+          include TableDefinition
+
+          def remove_represents(*args)
+            options = args.extract_options!
+            args.each do |col|
+              @base.remove_reference(@name, col, options)
+            end
+          end
+        end
+      end
+    end
+  end
+end