activerecord-virtual_attributes 1.5.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90da25c212d7507da2ca2789b1151b2e7cb7cb3936411a7e92823518299141b9
-  data.tar.gz: d2a3cc1662d29fa8625dab40610950a573c0014b9739dbb260184da47afdb2ac
+  metadata.gz: eb60079c2b76281f9ace2d7f4a25c9956d9c439c408b6d0df615cb8c4512a31f
+  data.tar.gz: 6eb95ac5ea930cd875c73e8fcfaca826e3f69370417489f9c074c2c90795e71e
 SHA512:
-  metadata.gz: 78c1edd3d1a17f5f4fcd147315e37c788cdfc3add3137a4190d568cc93ab1823d9de0e46a6f57f266d248104823578d5f6a86e076228ae640c52c035922910f4
-  data.tar.gz: 19ec2fafe3553b4ff809c1aae1aa6ccfd6f303216d1c35bc4a09f30e9dda2876a48fd531d9216e0a1a566de0434c90edd58936c12027b62bc9c70eb896235b50
+  metadata.gz: e0d8221e8ee5ce87f5082c7e3e7b821375e0da1c6109bd772c1ee01fb396de12169c3f6ac53cdddd267d7974785b81ca0047ccf4b0ed43278b79bdb84c2cd557
+  data.tar.gz: 0b980f5df648db206618fd304ac54fd69f84ed53e004226629ddcc389775686934291baaf106cf196b0fe5204107046bf437f6db12b41a632a62dba88c71b0a0

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,74 @@
+name: CI
+
+on: [push, pull_request]
+
+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
+        ports:
+        - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 2s
+          --health-timeout 5s
+          --health-retries 5
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: virtual_attributes
+        ports:
+        - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping -h 127.0.0.1 -P 3306 --silent"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 3
+    env:
+      # for the pg cli (psql, pg_isready) and possibly 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
+      - name: Run SQLite tests
+        env:
+          DB: sqlite3
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: bundle exec rake
+      - name: Run Postgres tests
+        env:
+          DB: pg
+          COLLATE_SYMBOLS: false
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: bundle exec rake
+      - name: Run MySQL tests
+        env:
+          DB: mysql2
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: bundle exec rake
+      - if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '2.7' }}
+        name: Report code coverage
+        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,11 +1,43 @@
-# Virtual Attributes Changelog
+# Change Log
 
-Doing our best at supporting [SemVer](http://semver.org/) with
-a nice looking [Changelog](http://keepachangelog.com).
+Versioning of this gem follows ActiveRecord versioning, and does not follow SemVer.
 
-## Version [Unreleased]
+e.g.: virtual attributes 6.1.x supports all versions of rails 6.1.
 
-## Version [1.5.0] <small>2019-12-02</small>
+Use the latest version of both this gem and rails where the first 2 digits match.
+
+## [Unreleased]
+
+## [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.
+* **BREAKING** removed legacy virtual_column parameter support. (it is not ruby 2.7 compatible)
+* fixed warnings in ruby 2.7
+
+## [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)
+
+## [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.
@@ -14,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
@@ -37,24 +69,28 @@ 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/v1.5.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.0...HEAD
+[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
 [1.4.0]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v1.3.1...v1.4.0
 [1.3.1]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v1.3.0...v1.3.1

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,16 @@
 # 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.
 
 ## Installation
 
@@ -42,6 +38,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+
+To test with different versions of ruby, use `wwtd` gem or
+
+DB=pg BUNDLE_GEMFILE=gemfiles/gemfile_${version-52}.gemfile bundle exec rake
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/activerecord-virtual_attributes .

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 = "1.5.0".freeze
+    VERSION = "6.1.0".freeze
   end
 end

data/lib/active_record/virtual_attributes/virtual_arel.rb

@@ -2,14 +2,46 @@ module ActiveRecord
   module VirtualAttributes
     # VirtualArel associates arel with an attribute
     #
-    # Model.virtual_attribute :field, :string, :arel => -> (t) { t.grouping(t[:field2]) } }
+    # Model.virtual_attribute :field, :string, :arel => ->(t) { t.grouping(t[:field2]) } }
     # Model.select(:field)
     #
     # is equivalent to:
     #
     # 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
+    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
@@ -18,17 +50,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)
-            col = _virtual_arel[column_name.to_s]
-            col.call(arel_table) if col
-          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
@@ -38,9 +72,26 @@ 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
+        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

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