activerecord-virtual_attributes 6.1.1 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a35d6c7665469341b76ae68e1a84180ccef887c47f56b7000efc2f0024d0a93
-  data.tar.gz: ba57d73a5034e461d3c6bd77a50eb5475d1fe0dab8c3332f91142c893fa736a2
+  metadata.gz: e19652ea9b4883f4acae661b63dcc69b4fa4b0bdd0b286a0eb8b17a87892278e
+  data.tar.gz: 2ba220783720e1bc5b67e0af787c1396127b3fef2f2e0813deb7e34b766579b8
 SHA512:
-  metadata.gz: 55f8e509034dc3a13dae283733da176c308d25538c38595cebfd98008d07be372c0843752e547be6afb5af361fd1610900f05fc52cdcdfbd8bff834b66233060
-  data.tar.gz: c4511ba748f911a985f308bdfa61f9d6c64c57ec1245003dea509205f3aa4e0085f20f7e9adb5674d3657d750c34e6c4d64d41ee5faebb18846c9e8ef3ea4c32
+  metadata.gz: 2b60fcf44b86210f1dbe3ab9be5585158c027bc9c81c0f2ccad77a0079a77b0918bc58feca99f550f4ad2aff4e61defaf7229b125f6091dd770df0242af645fe
+  data.tar.gz: e691ea9679a9fda6db72fc3f057dd7d5aee163e9fd1d4aff035292da1e03c23eb711920bad8cf79ad41054bb28c2ba29ac9a03a4a38d7b44a52b9ca322245e16

data/.github/workflows/ci.yaml

@@ -13,6 +13,8 @@ jobs:
       matrix:
         ruby-version:
         - '2.7'
+        - '3.0'
+        - '3.1'
     services:
       postgres:
         image: postgres:13
@@ -41,7 +43,7 @@ jobs:
       MYSQL_HOST: 127.0.0.1
       MYSQL_PWD: password
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -54,7 +56,7 @@ jobs:
         run: bundle exec rake
       - name: Run PostgreSQL tests
         env:
-          DB: pg
+          DB: postgresql
           COLLATE_SYMBOLS: false
         run: bundle exec rake
       - name: Run MySQL tests
@@ -62,8 +64,8 @@ jobs:
           DB: mysql2
         run: bundle exec rake
       - name: Report code coverage
-        if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '2.7' }}
+        if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.1' }}
         continue-on-error: true
-        uses: paambaati/codeclimate-action@v3.0.0
+        uses: paambaati/codeclimate-action@v5
         env:
           CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

data/CHANGELOG.md

@@ -4,6 +4,13 @@ The versioning of this gem follows ActiveRecord versioning, and does not follow
 
 ## [Unreleased]
 
+## [6.1.2] - 2023-10-26
+
+* Fix bind variables for joins with static strings [#124](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/124)
+* Add `virtual_total` for `habtm` [#123](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/123)
+* Fix: `:uses` clause now works with an array and nested hashes. [#120](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/120)
+* Uses symbols in the `includes()` clause. defined by `virtual_attribute :uses` and virtual_delegate. [#128](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/128)
+
 ## [6.1.1] - 2022-08-09
 
 * fix HomogeneousIn clauses [#111](https://github.com/ManageIQ/activerecord-virtual_attributes/pull/111)
@@ -86,7 +93,8 @@ The versioning of this gem follows ActiveRecord versioning, and does not follow
 * Initial Release
 * Extracted from ManageIQ/manageiq
 
-[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.1...HEAD
+[Unreleased]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.2...HEAD
+[6.1.2]: https://github.com/ManageIQ/activerecord-virtual_attributes/compare/v6.1.1...v6.1.2
 [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

data/README.md

@@ -1,8 +1,8 @@
 # VirtualAttributes
 
 [![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)
+[![Maintainability](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes.svg)](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes/maintainability)
+[![Test Coverage](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes/coverage.svg)](https://codeclimate.com/github/ManageIQ/activerecord-virtual_attributes/test_coverage)
 
 VirtualAttributes allows you to define a ruby method that acts like an attribute or relation.
 
@@ -40,14 +40,15 @@ TODO: Write usage instructions here
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` 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).
 
+To test with different database adapters, set the DB environment variable:
 
-To test with different versions of ruby, use `wwtd` gem or
-
-DB=pg BUNDLE_GEMFILE=gemfiles/gemfile_${version-52}.gemfile bundle exec rake
+    DB=postgresql bundle exec rake
+    DB=mysql bundle exec rake
+    DB=sqlite3 bundle exec rake
 
 ## Contributing
 
@@ -56,4 +57,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Manage
 ## License
 
 This project is available as open source under the terms of the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
-

data/activerecord-virtual_attributes.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "activerecord", "~> 6.1.0"
 
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "database_cleaner-active_record", "~> 2.1"
   spec.add_development_dependency "db-query-matchers"
   spec.add_development_dependency "manageiq-style"
   spec.add_development_dependency "rake", "~> 13.0"

data/bin/setup

@@ -1,8 +1,13 @@
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
+set -e
 
 bundle install
+echo
 
-# Do any other automated setup that you need to do here
+echo "Setting up the postgres database for specs..."
+echo "SELECT 'CREATE DATABASE virtual_attributes' WHERE NOT EXISTS (SELECT FROM pg_database WHERE datname = 'virtual_attributes')\gexec" | psql -U postgres
+
+echo "Setting up the mysql database for specs..."
+mysql -u root -e 'CREATE SCHEMA IF NOT EXISTS 'virtual_attributes';'

data/lib/active_record/virtual_attributes/version.rb

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

data/lib/active_record/virtual_attributes/virtual_arel.rb

@@ -36,10 +36,8 @@ module ActiveRecord
     end
 
     module VirtualArel
-      # This arel table proxy is our shim to get our functionality into rails
+      # This arel table proxy. This allows WHERE clauses to use virtual attributes
       class ArelTableProxy < Arel::Table
-        attr_accessor :klass
-
         # overrides Arel::Table#[]
         # adds aliases and virtual attribute arel (aka sql)
         #
@@ -70,16 +68,9 @@ module ActiveRecord
       end
 
       module ClassMethods
-        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
+        # ActiveRecord::Core 6.1
+        def arel_table
+          @arel_table ||= ArelTableProxy.new(table_name, :klass => self)
         end
 
         # supported by sql if any are true:

data/lib/active_record/virtual_attributes/virtual_delegates.rb

@@ -43,7 +43,7 @@ module ActiveRecord
             method_prefix = virtual_delegate_name_prefix(options[:prefix], to)
             method_name = "#{method_prefix}#{method}"
             if to.include?(".") # to => "target.method"
-              to, method = to.split(".")
+              to, method = to.split(".").map(&:to_sym)
               options[:to] = to
             end
 
@@ -260,8 +260,7 @@ module ActiveRecord
 
         yield arel if block_given?
 
-        # convert arel to sql to populate with bind variables
-        ::Arel::Nodes::Grouping.new(Arel.sql(arel.to_sql))
+        ::Arel::Nodes::Grouping.new(arel)
       end
 
       # determine table reference to use for a sub query

data/lib/active_record/virtual_attributes/virtual_fields.rb

@@ -35,7 +35,7 @@ module ActiveRecord
 
           case associations
           when String, Symbol
-            virtual_field?(associations) ? replace_virtual_fields(virtual_includes(associations)) : associations
+            virtual_field?(associations) ? replace_virtual_fields(virtual_includes(associations)) : associations.to_sym
           when Array
             associations.collect { |association| replace_virtual_fields(association) }.compact
           when Hash
@@ -67,9 +67,11 @@ module ActiveRecord
         def include_to_hash(value)
           case value
           when String, Symbol
-            {value => {}}
+            {value.to_sym => {}}
           when Array
-            value.flatten.each_with_object({}) { |k, h| h[k] = {} }
+            value.flatten.each_with_object({}) do |k, h|
+              merge_includes(h, k)
+            end
           when nil
             {}
           else
@@ -77,15 +79,21 @@ module ActiveRecord
           end
         end
 
-        # @param [Hash] hash1
-        # @param [Hash] hash2
+        # @param [Hash] hash1 (incoming hash is modified and returned)
+        # @param [Hash|Symbol|nil] hash2 (this hash will not be modified)
         def merge_includes(hash1, hash2)
           return hash1 if hash2.blank?
 
-          hash1 = include_to_hash(hash1)
-          hash2 = include_to_hash(hash2)
-          hash1.deep_merge!(hash2) do |_k, v1, v2|
-            merge_includes(v1, v2)
+          # very common case.
+          # optimization to skip deep_merge and hash creation
+          if hash2.kind_of?(Symbol)
+            hash1[hash2] ||= {}
+            return hash1
+          end
+
+          hash1.deep_merge!(include_to_hash(hash2)) do |_k, v1, v2|
+            # this block is conflict resolution when a key has 2 values
+            merge_includes(include_to_hash(v1), v2)
           end
         end
       end

data/lib/active_record/virtual_attributes/virtual_total.rb

@@ -114,7 +114,7 @@ module VirtualAttributes
       end
 
       def virtual_aggregate_arel(reflection, method_name, column)
-        return unless reflection && reflection.macro == :has_many
+        return unless reflection && [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
 
         # need db access for the reflection join_keys, so delaying all this key lookup until call time
         lambda do |t|
@@ -137,14 +137,8 @@ module VirtualAttributes
           # query: SELECT COUNT(*) FROM foreign_table JOIN ... [WHERE main_table.id = foreign_table.id]
           query.where(join.right.expr)
 
-          # convert bind variables from ? to actual values. otherwise, sql is incomplete
-          conn = connection
-          sql = conn.unprepared_statement { conn.to_sql(query) }
-
-          # add () around query
-          query = t.grouping(Arel::Nodes::SqlLiteral.new(sql))
           # add coalesce to ensure correct value comes out
-          t.grouping(Arel::Nodes::NamedFunction.new('COALESCE', [query, Arel::Nodes::SqlLiteral.new("0")]))
+          t.grouping(Arel::Nodes::NamedFunction.new('COALESCE', [t.grouping(query), Arel::Nodes::SqlLiteral.new("0")]))
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-virtual_attributes
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.1.2
 platform: ruby
 authors:
 - Keenan Brock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: db-query-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Access non-sql attributes from sql