activerecord-virtual_attributes 2.0.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ceef88d5be93e1f696e382623d09b421031eae65de7608241b14a943ff5c76c
-  data.tar.gz: bcf53221633defb009e5dbf739cf2466360c0a00e35bc312dec15d25def7406b
+  metadata.gz: 8a35d6c7665469341b76ae68e1a84180ccef887c47f56b7000efc2f0024d0a93
+  data.tar.gz: ba57d73a5034e461d3c6bd77a50eb5475d1fe0dab8c3332f91142c893fa736a2
 SHA512:
-  metadata.gz: 554b781f47a4fe637bad32ab5c194e4aa364c78dfb5d9a39f8877a3d22ed9c704b4f5ee8312a4220fe07b08eb5a9d4cb3aeb05af200cf0a54af10c4c2052bad4
-  data.tar.gz: 3feaf1fa331f0e40813591d33f7543cda134acf88e6a70516e8f5aa27c4941c999cfb63ceb2bc86b44bce359daed0ce11f79276f7d832d553f82c754f7206d07
+  metadata.gz: 55f8e509034dc3a13dae283733da176c308d25538c38595cebfd98008d07be372c0843752e547be6afb5af361fd1610900f05fc52cdcdfbd8bff834b66233060
+  data.tar.gz: c4511ba748f911a985f308bdfa61f9d6c64c57ec1245003dea509205f3aa4e0085f20f7e9adb5674d3657d750c34e6c4d64d41ee5faebb18846c9e8ef3ea4c32

data/.codeclimate.yml

@@ -1,11 +1,14 @@
----
 version: '2'
 prepare:
   fetch:
-  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
     path: ".rubocop_base.yml"
-  - url: https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_cc_base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
     path: ".rubocop_cc_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
+    path: styles/base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
+    path: styles/cc_base.yml
 checks:
   argument-count:
     enabled: false
@@ -27,6 +30,5 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: "rubocop-0-67"
-    config:
-      file: ".rubocop_cc.yml"
+    config: ".rubocop_cc.yml"
+    channel: rubocop-0-82

data/.github/workflows/ci.yaml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: '0 0 * * 0'
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.7'
+    services:
+      postgres:
+        image: postgres:13
+        env:
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: virtual_attributes
+        options: --health-cmd pg_isready --health-interval 2s --health-timeout 5s --health-retries 5
+        ports:
+        - 5432:5432
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: virtual_attributes
+        options: --health-cmd="mysqladmin ping -h 127.0.0.1 -P 3306 --silent" --health-interval 10s --health-timeout 5s --health-retries 3
+        ports:
+        - 3306:3306
+    env:
+      CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      # for the pg cli (psql, pg_isready) and rails
+      PGHOST: localhost
+      PGPORT: 5432
+      PGUSER: postgres
+      PGPASSWORD: password
+      # for the mysql cli (mysql, mysqladmin)
+      MYSQL_HOST: 127.0.0.1
+      MYSQL_PWD: password
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+        timeout-minutes: 30
+      - name: Run SQLite tests
+        env:
+          DB: sqlite3
+        run: bundle exec rake
+      - name: Run PostgreSQL tests
+        env:
+          DB: pg
+          COLLATE_SYMBOLS: false
+        run: bundle exec rake
+      - name: Run MySQL tests
+        env:
+          DB: mysql2
+        run: bundle exec rake
+      - name: Report code coverage
+        if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '2.7' }}
+        continue-on-error: true
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

data/.rubocop.yml

@@ -1,3 +1,4 @@
 inherit_from:
-- https://raw.githubusercontent.com/ManageIQ/guides/master/.rubocop_base.yml
-- .rubocop_local.yml
+- ".rubocop_local.yml"
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"

data/.rubocop_cc.yml

@@ -1,4 +1,4 @@
 inherit_from:
-- .rubocop_base.yml
-- .rubocop_cc_base.yml
-- .rubocop_local.yml
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -1,23 +1,43 @@
-# Virtual Attributes Changelog
+# Change Log
 
-Doing our best at supporting [SemVer](http://semver.org/) with
-a nice looking [Changelog](http://keepachangelog.com).
+The versioning of this gem follows ActiveRecord versioning, and does not follow SemVer.  See the [README](./README.md) for more details.
 
-## Version [Unreleased] <small>tbd</small>
+## [Unreleased]
 
-## Version [2.0.0] <small>2020-05-22</small>
+## [6.1.1] - 2022-08-09
+
+* fix HomogeneousIn clauses [#111](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/111)
+
+## [6.1.0] - 2022-02-03
+
+* **BREAKING** Dropped support for Rails 5.0, 5.1, 5.2, 6.0
+* **BREAKING** This gem will now no longer follow Semantic Versioning,
+  but instead follow Rails' versioning numbers in order to simplify version
+  matches between them both.
+* Added Rails 6.1 support
+* Ruby 3.0 compatibility: kwargs, regular expression fixes
+* changed extension mechanism from `arel_attribute()` to `arel_table[]`
+* Auto add grouping to virtual attribute arel
+
+## [3.0.0] - 2020-09-28
+
+* fix virtual_aggregate to return a consistent 0 when calculating a sum of no records
+* fix virtual delegate to include the type column when fetching associated models for polymorphism
+* add virtual_average, virtual_minimum, and virtual_maximum
+
+## [2.0.0] - 2020-05-22
 
 * This is a trivial release, but because it modifies a public interface, the jump makes it look significant.
-* removed legacy virtual_column parameter support. (it is not ruby 2.7 compatible)
+* **BREAKING** removed legacy virtual_column parameter support. (it is not ruby 2.7 compatible)
 * fixed warnings in ruby 2.7
 
-## Version [1.6.0] <small>2019-12-02</small>
+## [1.6.0] - 2019-12-02
 
 * rails 5.2 support
 * fix Arel#name error
 * Display deprecation notices for invalid associations (rather than throw an error)
 
-## Version [1.5.0] <small>2019-12-02</small>
+## [1.5.0] - 2019-12-02
 
 * `select()` no longer modifies `select_values`. It understands virtual attributes at a lower level.
 * `includes()` can now handle all proper values presented.
@@ -26,22 +46,22 @@ a nice looking [Changelog](http://keepachangelog.com).
 * rails 6.0 support, (rails 5.2 only fails `habtm` preloading)
 * ruby 2.6.x support (no longer testing ruby 2.4)
 
-## Version [1.4.0] <small>2019-07-13</small>
+## [1.4.0] - 2019-07-13
 
 * fix includes to include all associations
 * fix bin/console to now actually run
 * select no longer munges field attribute
 * support virtual attributes in left_outer_joins
 
-## Version [1.3.1] <small>2019-06-06</small>
+## [1.3.1] - 2019-06-06
 
 * quote column aliases
 
-## Version [1.3.0] <small>2019-05-24</small>
+## [1.3.0] - 2019-05-24
 
 * Rails 5.2 support
 
-## Version [1.2.0] <small>2019-04-23</small>
+## [1.2.0] - 2019-04-23
 
 * Virtual_delegate :type now specified to avoid rare race conditions with attribute discovery
 * Delays interpreting delegate until column is used
@@ -49,24 +69,27 @@ a nice looking [Changelog](http://keepachangelog.com).
 * More flexible includes. e.g.: Arrays of symbols now work
 * Raises errors for invalid `includes()` and `:uses`
 
-## Version [1.1.0] <small>2019-04-23</small>
+## [1.1.0] - 2019-04-23
 
 * Add legacy types for `VirtualAttribute::Types`
 * Fix rails 5.1 bug with `includes()`
 * Remove reference to `MiqPreloader`
 
-## Version [1.0.0] <small>2019-03-05</small>
+## [1.0.0] - 2019-03-05
 
 * Renamed to activerecord-virtual_attributes
 * Moved from ManageIQ to own repo
 * Added support for Rails 5.1
 
-## Version 0.1.0 <small>2019-01-17</small>
+## 0.1.0 - 2019-01-17
 
 * Initial Release
 * Extracted from ManageIQ/manageiq
 
-[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v2.0.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.1...HEAD
+[6.1.1]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.0...v6.1.1
+[6.1.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v3.0.0...v6.1.0
+[3.0.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v2.0.0...v3.0.0
 [2.0.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v1.6.0...v2.0.0
 [1.6.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v1.4.0...v1.5.0

data/Gemfile

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.0.7"
-gem "mysql2", '~> 0.4.0'
+gem "activerecord", "~> 6.1.4"
+gem "mysql2"
 gem "pg"
-gem "sqlite3", "~> 1.3.6"
+gem "sqlite3"
 
 gemspec

data/README.md

@@ -1,20 +1,22 @@
 # VirtualAttributes
 
-[![Build Status](https://travis-ci.org/ManageIQ/activerecord-virtual_attributes.svg?branch=master)](https://travis-ci.org/ManageIQ/activerecord-virtual_attributes)
+[![CI](https://github.com/ManageIQ/activerecord-virtual_attributes/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/activerecord-virtual_attributes/actions/workflows/ci.yaml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e1a0c26941c00f4edb55/maintainability)](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/e1a0c26941c00f4edb55/test_coverage)](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes/test_coverage)
-[![Security](https://hakiri.io/github/ManageIQ/activerecord-virtual_attributes/master.svg)](https://hakiri.io/github/ManageIQ/activerecord-virtual_attributes/master)
 
-This allows you to define a ruby method that acts like an attribute or relation.
+VirtualAttributes allows you to define a ruby method that acts like an attribute or relation.
 
-Sometimes you have a model with an attribute defined in ruby, but you want to sort by it or filter by it.
-Well, to filter by that attribute, you need to fetch all the rows from the database and filter it in ruby.
-For large tables, this is slow and takes up a lot of memory
+Sometimes you have a model with an attribute defined in ruby but you want to sort or filter by it. Filtering by that attribute necessitates fetching all the rows from the database and filtering in ruby. For large tables, this is slow and takes up a lot of memory.
 
-This gem allows you to represent these attribute in sql so `ORDER BY` `WHERE` clauses will work.
+This gem allows you to represent these attributes in sql so `ORDER BY` `WHERE` clauses will work.
 
-This gem also allows you to calculate counts, and treat those counts as a field accessible with `select(:child_count)`
-to get rid of the N+1 problem of running a `count(*)` on a subcollection for each row.
+This also allows you to calculate counts and treat those as a field accessible with `select(:child_count)` to get rid of the N+1 problem of running a `count(*)` on a subcollection for each row.
+
+## Versioning
+
+As of v6.1.0, the versioning of this gem follows ActiveRecord versioning, and does not follow SemVer (e.g. virtual attributes v6.1.x supports all versions of Rails 6.1). Version v3.0.0 supports Rails 6.0 and lower.
+
+Use the latest version of both this gem and Rails where the first 2 digits match.
 
 ## Installation
 
@@ -45,7 +47,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 To test with different versions of ruby, use `wwtd` gem or
 
-DB=pg BUNDLE_GEMFILE=gemfiles/gemfile_${version-52}.gemfile beer "$@"
+DB=pg BUNDLE_GEMFILE=gemfiles/gemfile_${version-52}.gemfile bundle exec rake
 
 ## Contributing
 

data/activerecord-virtual_attributes.gemspec

@@ -25,11 +25,12 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", ">= 5.0"
+  spec.add_runtime_dependency "activerecord", "~> 6.1.0"
 
-  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "db-query-matchers"
+  spec.add_development_dependency "manageiq-style"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov", ">= 0.21.2"
 end

data/lib/active_record/virtual_attributes/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module VirtualAttributes
-    VERSION = "2.0.0".freeze
+    VERSION = "6.1.1".freeze
   end
 end

data/lib/active_record/virtual_attributes/virtual_arel.rb

@@ -9,11 +9,59 @@ module ActiveRecord
     #
     # Model.select(Model.arel_table.grouping(Model.arel_table[:field2]).as(:field))
     # Model.attribute_supported_by_sql?(:field) # => true
+
+    # in essence, this is our Arel::Nodes::VirtualAttribute
     class Arel::Nodes::Grouping
-      attr_accessor :name
+      attr_accessor :name, :relation
+
+      # methods from Arel::Nodes::Attribute
+      def type_caster
+        relation.type_for_attribute(name)
+      end
+
+      # Create a node for lowering this attribute
+      def lower
+        relation.lower(self)
+      end
+
+      def type_cast_for_database(value)
+        relation.type_cast_for_database(name, value)
+      end
+
+      # rubocop:disable Rails/Delegate
+      def able_to_type_cast?
+        relation.able_to_type_cast?
+      end
+      # rubocop:enable Rails/Delegate
     end
 
     module VirtualArel
+      # This arel table proxy is our shim to get our functionality into rails
+      class ArelTableProxy < Arel::Table
+        attr_accessor :klass
+
+        # overrides Arel::Table#[]
+        # adds aliases and virtual attribute arel (aka sql)
+        #
+        # @returns Arel::Attributes::Attribute|Arel::Nodes::Grouping|Nil
+        # for regular database columns:
+        #     returns an Arel::Attribute (just like Arel::Table#[])
+        # for virtual attributes:
+        #     returns the arel for the value
+        # for non sql friendly virtual attributes:
+        #     returns nil
+        def [](name, table = self)
+          if (col_alias = @klass.attribute_alias(name))
+            name = col_alias
+          end
+          if @klass.virtual_attribute?(name)
+            @klass.arel_for_virtual_attribute(name, table)
+          else
+            super
+          end
+        end
+      end
+
       extend ActiveSupport::Concern
 
       included do
@@ -22,20 +70,19 @@ module ActiveRecord
       end
 
       module ClassMethods
-        def arel_attribute(column_name, arel_table = self.arel_table)
-          load_schema
-          if virtual_attribute?(column_name) && !attribute_alias?(column_name)
-            if (col = _virtual_arel[column_name.to_s])
-              arel = col.call(arel_table)
-              arel.name = column_name if arel.kind_of?(Arel::Nodes::Grouping)
-              arel
-            end
-          else
-            super
+        if ActiveRecord.version.to_s < "6.1"
+          # ActiveRecord::Core 6.0 (every version of active record seems to do this differently)
+          def arel_table
+            @arel_table ||= ArelTableProxy.new(table_name, :type_caster => type_caster).tap { |t| t.klass = self }
+          end
+        else
+          # ActiveRecord::Core 6.1
+          def arel_table
+            @arel_table ||= ArelTableProxy.new(table_name, :klass => self)
           end
         end
 
-        # supported by sql if
+        # supported by sql if any are true:
         # - it is an attribute alias
         # - it is an attribute that is non virtual
         # - it is an attribute that is virtual and has arel defined
@@ -45,12 +92,70 @@ module ActiveRecord
             (has_attribute?(name) && (!virtual_attribute?(name) || !!_virtual_arel[name.to_s]))
         end
 
+        # private api
+        #
+        # @return [Nil|Arel::Nodes::Grouping]
+        #   for virtual attributes:
+        #       returns the arel for the column
+        #   for non sql friendly virtual attributes:
+        #       returns nil
+        def arel_for_virtual_attribute(column_name, table) # :nodoc:
+          arel_lambda = _virtual_arel[column_name.to_s]
+          return unless arel_lambda
+
+          arel = arel_lambda.call(table)
+          arel = Arel::Nodes::Grouping.new(arel) unless arel.kind_of?(Arel::Nodes::Grouping)
+          arel.name = column_name
+          arel.relation = table
+          arel
+        end
+
         private
 
-        def define_virtual_arel(name, arel)
+        def define_virtual_arel(name, arel) # :nodoc:
           self._virtual_arel = _virtual_arel.merge(name => arel)
         end
       end
     end
   end
 end
+
+module Arel # :nodoc: all
+  # rubocop:disable Naming/MethodName
+  # rubocop:disable Naming/MethodParameterName
+  # rubocop:disable Style/ConditionalAssignment
+  module Visitors
+    # rails 6.1...
+    class ToSql
+      private
+
+      def visit_Arel_Nodes_HomogeneousIn(o, collector)
+        collector.preparable = false
+
+        # change:
+        # See https://github.com/rails/rails/pull/45642
+        visit(o.left, collector)
+        # /change
+
+        if o.type == :in
+          collector << " IN ("
+        else
+          collector << " NOT IN ("
+        end
+
+        values = o.casted_values
+
+        if values.empty?
+          collector << @connection.quote(nil)
+        else
+          collector.add_binds(values, o.proc_for_binds, &bind_block)
+        end
+
+        collector << ")"
+      end
+    end
+  end
+  # rubocop:enable Naming/MethodName
+  # rubocop:enable Naming/MethodParameterName
+  # rubocop:enable Style/ConditionalAssignment
+end

data/lib/active_record/virtual_attributes/virtual_delegates.rb

@@ -151,14 +151,9 @@ module ActiveRecord
           # There is currently no way to propagate sql over a virtual association
           if reflect_on_association(to_ref.name) && (to_ref.macro == :has_one || to_ref.macro == :belongs_to)
             lambda do |t|
-              join_keys = if ActiveRecord.version.to_s >= "5.1"
-                            to_ref.join_keys
-                          else
-                            to_ref.join_keys(to_ref.klass)
-                          end
-              src_model_id = arel_attribute(join_keys.foreign_key, t)
+              src_model_id = arel_table[to_ref.join_foreign_key, t]
               blk = ->(arel) { arel.limit = 1 } if to_ref.macro == :has_one
-              VirtualDelegates.select_from_alias(to_ref, col, join_keys.key, src_model_id, &blk)
+              VirtualDelegates.select_from_alias(to_ref, col, to_ref.join_primary_key, src_model_id, &blk)
             end
           end
         end
@@ -240,6 +235,7 @@ module ActiveRecord
       #     (SELECT "vms_sub"."name" FROM "vms" AS "vms_ss" WHERE "vms_ss"."id" = "vms"."src_template_id")
       #
 
+      # Based upon ActiveRecord AssociationScope.scope
       def self.select_from_alias(to_ref, col, to_model_col_name, src_model_id)
         query = if to_ref.scope
                   to_ref.klass.instance_exec(nil, &to_ref.scope)
@@ -247,16 +243,25 @@ module ActiveRecord
                   to_ref.klass.all
                 end
 
-        to_table    = select_from_alias_table(to_ref.klass, src_model_id.relation)
-        to_model_id = to_ref.klass.arel_attribute(to_model_col_name, to_table)
-        to_column   = to_ref.klass.arel_attribute(col, to_table)
-        arel        = query.except(:select).select(to_column).arel
-                           .from(to_table)
-                           .where(to_model_id.eq(src_model_id))
+        src_model = to_ref.active_record
+        to_table  = select_from_alias_table(to_ref.klass, src_model_id.relation)
+        to_model_id = to_ref.klass.arel_table[to_model_col_name, to_table]
+        to_column   = to_ref.klass.arel_table[col, to_table]
+        arel = query.except(:select).select(to_column).arel
+                    .from(to_table)
+                    .where(to_model_id.eq(src_model_id))
+
+        # :type is in the reflection definition (meaning it is polymorphic)
+        if to_ref.type
+          # get the class name (e.g. "Host")
+          polymorphic_type = src_model.base_class.name
+          arel = arel.where(to_ref.klass.arel_table[to_ref.type].eq(polymorphic_type))
+        end
 
         yield arel if block_given?
 
-        Arel.sql("(#{arel.to_sql})")
+        # convert arel to sql to populate with bind variables
+        ::Arel::Nodes::Grouping.new(Arel.sql(arel.to_sql))
       end
 
       # determine table reference to use for a sub query