active_record_include 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30de7b63680167a66f60ec0f0e62341dd070dd72
+  data.tar.gz: 6d1a4b3d921cb01d3a05dbf08944cf6906b6a6fc
+SHA512:
+  metadata.gz: 46f8afba0e9307c161b502f944cfbcd6388d93c6baf3e902ff5ca9fea7ab01a63e275f4ee7acb7fc15b9f98cbcaa22716934ac0cad409dfbf2d2ac56e1dc6209
+  data.tar.gz: 771dd3d979e25060b286694b0b3e770edeee511c3d4e8ffe07a930d56c13a3b6925f634c250c3cc6fa31b3d4b74b7db93f220ac0a26d96093cefa91aeffab160

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.4.1
+before_install: gem install bundler -v 1.17.1

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 active_record_include.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    active_record_include (0.1.0)
+      activerecord (>= 4.2, < 5.3)
+      activesupport (>= 4.2, < 5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    normalizy (1.2.0)
+      activerecord (>= 4.1, < 6)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_include!
+  bundler (~> 1.17)
+  byebug
+  normalizy
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.17.1

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2018 Tyler Rick
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,149 @@
+# ActiveRecordInclude
+
+Have you ever wanted to make a module get included into *all* of your models so that you don't have
+to remember to include in each individual model?
+
+Sure, if all you need is for some methods to be *available* in all your models, then you can just
+include the module in your `ApplicationRecord` and all subclasses of `ApplicationRecord` will have
+access to those methods by inheritance.
+
+But if it's a `ActiveSupport::Concern` with a `included` blocks or similar that needs to do
+something specific for each individual model subclass, then that approach doesn't work.
+
+You can do something like this to automatically include `MyConcern` into all subclasses of
+`ApplicationRecord`:
+
+```ruby
+module MyExtensions
+  module ClassMethods
+
+  private
+
+    # These extensions aren't on (or can't be on) Base itself but on every model (every subclass of
+    # Base)
+    def inherited(subclass)
+      super
+      subclass.class_eval do
+        include MyConcern
+      end
+    end
+  end
+end
+
+class ApplicationRecord < ActiveRecord::Base
+  include MyExtensions
+end
+```
+
+Or you could use this gem and just write:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include_when_inherited MyConcern
+end
+```
+
+However, even that doesn't always work.  If we try to connect to a table from `MyConcern` that way,
+we'll end up getting an error like this:
+
+```
+  PG::UndefinedTable: ERROR:  relation "application_records" does not exist
+```
+
+Model extensions/concerns that require an database connection (such as those that get a list of columns for
+the model) can't be automatically included from `inherited()` because that's too early (`inherited`
+gets called the moment it hits the `class Model < ApplicationRecord` line), *before* the body of the class
+definition has been evaluated, and thus before the model (or its ancestors) has had a chance to
+configure itself with `self.abstract_class=` or `self.table_name=` yet, for example.
+
+Do this to have it include the given module in all (non-abstract) model subclasses as soon as that model
+has connected to its database:
+
+```ruby
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+    include_when_connected NormalizeTextColumns
+  end
+```
+
+By default, it includes the module into all subclasses. If you *don't* want it to include the module into subclasses, pass `recursive: false`.
+
+```ruby
+  class SomeModel < ActiveRecord::Base
+    include_when_connected MyConcern, recursive: false
+  end
+```
+
+
+## Limitations
+
+### `ActiveSupport::Concern` modules are only included if the module is not already an ancestor
+
+This means that the order you include concerns matters.
+
+If you have `AA < A < ApplicationRecord` and you include the concern into `A` and then `AA`, when
+you include it into `AA` the `included` block will not be run for `AA`, because it has already been
+run for an ancestor of `AA`, namely `A`.
+
+If on the other hand you somehow managed to include the concern into `AA` *before* it got included
+into `A`, you *can* get it include the `included` block of the concern for both `AA` *and* `A`. But
+this is easier said then done, because `A` needs to be defined first before you can
+subclass it, and usually they are in different files so it would get included into `A` as soon as
+the file for `A` was loaded.  You would have to be very, very intentional about it, and reopen `A`,
+like this:
+
+```
+class A < ApplicationRecord
+end
+class AA < A
+  include MyConcern
+end
+class A
+  include MyConcern
+end
+```
+
+This is a limitation of `ActiveSupport::Concern`, not of this gem. (`include_when_inherited` calls
+`include` to include the concern, but it has no effect.)
+
+Often this limitation isn't a problem, because all of your models are direct descendents of
+`ApplicationRecord` and you don't need to *also* include the concern into `ApplicationRecord`, for
+example.
+
+But if you really need a module's features to be appended (its `included` code) into both a model
+and its superclass, one way to work around this limitation is to define your own `included`
+callback, like we did in
+[`spec/support/models/concerns/creature_self_identification.rb`](spec/support/models/concerns/creature_self_identification.rb):
+
+```ruby
+  def self.included(base)
+    base.class_eval do
+      puts "#{self}: included CreatureSelfIdentification"
+      extend ClassMethods
+      define_identity_methods
+    end
+  end
+```
+
+Then you can call `include_recursively` from the base class of the class hierarchy you want to
+include the module in, and it will append its features to *all* of its descendents:
+
+```ruby
+class Creature < ApplicationRecord
+  include CreatureConcern
+  include_recursively CreatureSelfIdentification
+end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_include'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/active_record_include.

data/active_record_include.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record_include/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_include"
+  spec.version       = ActiveRecordInclude.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Makes it easy to have specific concern modules included into all of your models after the model has connected to the database}
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/TylerRick/active_record_include"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "TODO: Put your gem's Changelog.md URL here."
+
+  # 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.required_ruby_version = ">= 2.3.0"
+  spec.add_dependency "activesupport", [">= 4.2", "< 5.3"]
+  spec.add_dependency "activerecord", [">= 4.2", "< 5.3"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "normalizy"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "byebug"
+end

data/bin/console

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

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'active_record'
+require 'active_record/base'
+
+require 'active_record_include/version'
+require 'active_record_include/when_inherited'
+require 'active_record_include/when_connected'

data/lib/active_record_include/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecordInclude
+  def self.version
+    "0.1.0"
+  end
+end

data/lib/active_record_include/when_connected.rb

@@ -0,0 +1,68 @@
+module ActiveRecordInclude::WhenConnected
+  extend ActiveSupport::Concern
+
+  mattr_accessor :verbose, instance_accessor: false
+  @@verbose = false
+
+  module ClassMethods
+    def include_when_connected(mod, **options)
+      self.class_eval do
+        unless    defined?(modules_to_include_when_connected)
+          class_attribute :modules_to_include_when_connected
+        end
+      end
+      #puts %(#{self}.modules_to_include_when_connected=#{self.modules_to_include_when_connected.inspect})
+      if options[:recursive] == false
+        options[:into_classes] ||= [self]
+      end
+      self.modules_to_include_when_connected ||= []
+      self.modules_to_include_when_connected  |= [{mod => options}]
+      unless self < OnConnect
+        include     OnConnect
+      end
+    end
+  end
+
+  module OnConnect
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+    def connection(*)
+      super.tap do
+        self.modules_to_include_when_connected.each do |config|
+        config.each do |(mod, options)|
+          self.singleton_class.class_eval do
+            attr_accessor :modules_already_included_when_connected
+          end
+          self.modules_already_included_when_connected ||= []
+          next if self.modules_already_included_when_connected.include?(mod)
+
+          match = (
+            if options[:into_classes]
+              self.in? options[:into_classes]
+            else
+              self < ActiveRecord::Base && !self.abstract_class?
+            end
+          )
+          #puts %(Include #{mod} into #{self} (#{options.inspect})? #{match})
+          if match
+            puts "Including #{mod} into #{self}" if ActiveRecordInclude::WhenConnected.verbose
+            modules_already_included_when_connected << mod
+            class_eval do
+              include mod
+            end
+          end
+        end
+        end
+      end
+    end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.class_eval do
+    include ActiveRecordInclude::WhenConnected
+  end
+end
+

data/lib/active_record_include/when_inherited.rb

@@ -0,0 +1,54 @@
+module ActiveRecordInclude::WhenInherited
+  extend ActiveSupport::Concern
+
+  mattr_accessor :verbose, instance_accessor: false
+  @@verbose = false
+
+  module ClassMethods
+    def include_when_inherited(mod)
+      self.class_eval do
+        unless    defined?(modules_to_include_when_inherited)
+          class_attribute :modules_to_include_when_inherited
+        end
+      end
+      #puts %(#{self}.modules_to_include_when_inherited=#{self.modules_to_include_when_inherited.inspect})
+      self.modules_to_include_when_inherited ||= []
+      self.modules_to_include_when_inherited  |= [mod]
+      unless self < OnInherit
+        include     OnInherit
+      end
+    end
+    alias_method :include_in_subclasses, :include_when_inherited
+
+    def include_recursively(mod)
+      include               mod
+      include_in_subclasses mod
+    end
+  end
+
+  module OnInherit
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      private
+      def inherited(subclass)
+        super.tap do
+          subclass.modules_to_include_when_inherited.each do |mod|
+            if subclass < ActiveRecord::Base && !subclass.abstract_class?
+              puts "Including #{mod} into #{subclass}#{' (already an ancestor)' if self < mod}" if ActiveRecordInclude::WhenInherited.verbose
+              subclass.class_eval do
+                include mod
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.class_eval do
+    include ActiveRecordInclude::WhenInherited
+  end
+end

data/lib/active_record_text_columns.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext/object/inclusion'
+
+module ActiveRecordTextColumns
+  extend ActiveSupport::Concern
+
+  included do
+    puts "#{self}: included ActiveRecordTextColumns" if ActiveRecordInclude::WhenInherited.verbose
+  end
+
+  module ClassMethods
+    def text_columns
+      columns.
+        select {|_| _.type.in? [:string, :text, :citext]}.
+        reject {|_| _.name.to_sym.in? text_columns_not_treated_as_text.map(&:to_sym) if respond_to?(:text_columns_not_treated_as_text) }
+    end
+    def text_column_names
+      text_columns.map(&:name).map(&:to_sym)
+    end
+  end
+
+  # Get a list of text_column_names for every model
+  def self.text_column_names_by_model
+    ::ActiveRecord::Base.descendants.each_with_object({}) do |model, hash|
+      next if model.abstract_class?
+      hash[model.name] = model.text_column_names
+    end
+  end
+end

data/lib/normalize_text_columns.rb

@@ -0,0 +1,10 @@
+require 'active_record_text_columns'
+
+module NormalizeTextColumns
+  extend ActiveSupport::Concern
+
+  included do
+    #puts "#{self}: included NormalizeTextColumns"
+    normalizy *text_column_names, with: [:strip, :null_if_blank]
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: active_record_include
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !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: '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: sqlite3
+  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: normalizy
+  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: pry
+  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: byebug
+  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: Makes it easy to have specific concern modules included into all of your
+  models after the model has connected to the database
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- License
+- Rakefile
+- Readme.md
+- active_record_include.gemspec
+- bin/console
+- bin/setup
+- lib/active_record_include.rb
+- lib/active_record_include/version.rb
+- lib/active_record_include/when_connected.rb
+- lib/active_record_include/when_inherited.rb
+- lib/active_record_text_columns.rb
+- lib/normalize_text_columns.rb
+homepage: http://github.com/TylerRick/active_record_include
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/TylerRick/active_record_include
+  source_code_uri: http://github.com/TylerRick/active_record_include
+  changelog_uri: 'TODO: Put your gem''s Changelog.md URL here.'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Makes it easy to have specific concern modules included into all of your
+  models after the model has connected to the database
+test_files: []