activerecord-virtual_attributes 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ceef88d5be93e1f696e382623d09b421031eae65de7608241b14a943ff5c76c
-  data.tar.gz: bcf53221633defb009e5dbf739cf2466360c0a00e35bc312dec15d25def7406b
+  metadata.gz: f205435ff8ec8ecda2020356916188e8c145dedfd57e9e9a89c7c3c743afa57a
+  data.tar.gz: 3485ee96f78567ef4fd98eec35dc6350313c543c6e5606c1ad4191812a25d534
 SHA512:
-  metadata.gz: 554b781f47a4fe637bad32ab5c194e4aa364c78dfb5d9a39f8877a3d22ed9c704b4f5ee8312a4220fe07b08eb5a9d4cb3aeb05af200cf0a54af10c4c2052bad4
-  data.tar.gz: 3feaf1fa331f0e40813591d33f7543cda134acf88e6a70516e8f5aa27c4941c999cfb63ceb2bc86b44bce359daed0ce11f79276f7d832d553f82c754f7206d07
+  metadata.gz: 700653df253780ef026120bdaa639e14adc4ed2c5ee735575d6a42a8335833791ab8dff596de8195b3c07f9da68d55e535a70cd20edc7b3ed2d973cf23aab177
+  data.tar.gz: e4ae06737ca3973621e673b18388f0bc9a0012efbe2e569857de4b718a7a89ae3324f27ff3cbac91d0d7c8da6456bd36cee1161dec771b6af3f8bde0ced8f65b

data/CHANGELOG.md

@@ -5,6 +5,12 @@ a nice looking [Changelog](http://keepachangelog.com).
 
 ## Version [Unreleased] <small>tbd</small>
 
+## Version [3.0.0] <small>2020-09-28</small>
+
+* 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
+
 ## Version [2.0.0] <small>2020-05-22</small>
 
 * This is a trivial release, but because it modifies a public interface, the jump makes it look significant.
@@ -66,7 +72,8 @@ a nice looking [Changelog](http://keepachangelog.com).
 * 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/v3.0.0...HEAD
+[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/activerecord-virtual_attributes.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "db-query-matchers", "~>0.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov"

data/lib/active_record/virtual_attributes/version.rb

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

data/lib/active_record/virtual_attributes/virtual_delegates.rb

@@ -240,6 +240,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,6 +248,7 @@ module ActiveRecord
                   to_ref.klass.all
                 end
 
+        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_attribute(to_model_col_name, to_table)
         to_column   = to_ref.klass.arel_attribute(col, to_table)
@@ -254,6 +256,13 @@ module ActiveRecord
                            .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_attribute(to_ref.type).eq(polymorphic_type))
+        end
+
         yield arel if block_given?
 
         Arel.sql("(#{arel.to_sql})")

data/lib/active_record/virtual_attributes/virtual_total.rb

@@ -5,7 +5,7 @@ module VirtualAttributes
     module ClassMethods
       private
 
-      # define an attribute to calculating the total of a has many relationship
+      # define an attribute to calculate the total of a has many relationship
       #
       #  example:
       #
@@ -25,24 +25,45 @@ module VirtualAttributes
       #   # arel == (SELECT COUNT(*) FROM vms where ems.id = vms.ems_id)
       #
       def virtual_total(name, relation, options = {})
-        define_virtual_size_method(name, relation)
         define_virtual_aggregate_attribute(name, relation, :count, Arel.star, options)
+        define_method(name) { (has_attribute?(name) ? self[name] : send(relation).try(:size)) || 0 }
       end
 
-      # define an attribute to calculate the sum of a has may relationship
+      def virtual_sum(name, relation, column, options = {})
+        define_virtual_aggregate_attribute(name, relation, :sum, column, options)
+        define_virtual_aggregate_method(name, relation, column, :sum)
+      end
+
+      def virtual_minimum(name, relation, column, options = {})
+        define_virtual_aggregate_attribute(name, relation, :minimum, column, options)
+        define_virtual_aggregate_method(name, relation, column, :min, :minimum)
+      end
+
+      def virtual_maximum(name, relation, column, options = {})
+        define_virtual_aggregate_attribute(name, relation, :maximum, column, options)
+        define_virtual_aggregate_method(name, relation, column, :max, :maximum)
+      end
+
+      def virtual_average(name, relation, column, options = {})
+        define_virtual_aggregate_attribute(name, relation, :average, column, options)
+        define_virtual_aggregate_method(name, relation, column, :average) { |values| values.count == 0 ? 0 : values.sum / values.count }
+      end
+
+      #  @param method_name
+      #    :count :average :minimum :maximum :sum
       #
       #  example:
       #
       #    class Hardware
       #      has_many :disks
-      #      virtual_aggregate :allocated_disk_storage, :disks, :sum, :size
+      #      virtual_sum :allocated_disk_storage, :disks, :size
       #    end
       #
       #    generates:
       #
       #    def allocated_disk_storage
       #      if disks.loaded?
-      #        disks.blank? ? nil : disks.map(&:size).compact.sum
+      #        disks.map(&:size).compact.sum
       #      else
       #        disks.sum(:size) || 0
       #      end
@@ -53,10 +74,8 @@ module VirtualAttributes
       #    # arel => (SELECT sum("disks"."size") where "hardware"."id" = "disks"."hardware_id")
 
       def virtual_aggregate(name, relation, method_name = :sum, column = nil, options = {})
-        return define_virtual_total(name, relation, options) if method_name == :size
-
-        define_virtual_aggregate_method(name, relation, method_name, column)
-        define_virtual_aggregate_attribute(name, relation, method_name, column, options)
+        return virtual_total(name, relation, options) if method_name == :size
+        return virtual_sum(name, relation, column, options) if method_name == :sum
       end
 
       def define_virtual_aggregate_attribute(name, relation, method_name, column, options)
@@ -77,20 +96,19 @@ module VirtualAttributes
         end
       end
 
-      def define_virtual_size_method(name, relation)
-        define_method(name) do
-          (has_attribute?(name) ? self[name] : send(relation).try(:size)) || 0
-        end
-      end
-
-      def define_virtual_aggregate_method(name, relation, method_name, column)
+      def define_virtual_aggregate_method(name, relation, column, ruby_method_name, arel_method_name = ruby_method_name)
         define_method(name) do
-          if attribute_present?(name)
-            self[name]
+          if has_attribute?(name)
+            self[name] || 0
           elsif (rel = send(relation)).loaded?
-            rel.blank? ? nil : rel.map { |t| t.send(column) }.compact.send(method_name)
+            values = rel.map { |t| t.send(column) }.compact
+            if block_given?
+              yield values
+            else
+              values.blank? ? nil : values.send(ruby_method_name)
+            end
           else
-            rel.try(method_name, column) || 0
+            rel.try(arel_method_name, column) || 0
           end
         end
       end
@@ -128,7 +146,9 @@ module VirtualAttributes
                  end
 
           # add () around query
-          t.grouping(Arel::Nodes::SqlLiteral.new(sql))
+          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")]))
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-virtual_attributes
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Keenan Brock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: db-query-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +157,7 @@ metadata:
   homepage_uri: https://github.com/ManageIQ/activerecord-virtual_attributes
   source_code_uri: https://github.com/ManageIQ/activerecord-virtual_attributes
   changelog_uri: https://github.com/ManageIQ/activerecord-virtual_attributes/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,9 +172,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Access non-sql attributes from sql
 test_files: []