occams-record 1.7.1 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc125a06b3fa732e1064483f13e5abbe2a7c64b4e6ac7f1b2d37337d8e233cb
-  data.tar.gz: 5c47a9a644b757463d5dd1961c1b86ed1de50cf247a286e8d1d0c3dd5daa99b8
+  metadata.gz: 2778b16aee6b725c967c4877b9905eed75b37b64bf8c5fca7077918ea2a4a53a
+  data.tar.gz: b8948ddd57573efcbeb90e96235626e482cc557e9b92d4e5fdf0237c182e39df
 SHA512:
-  metadata.gz: 7fb55ec18a98e4d2bb4b3fab8d3f609a378bee578d1b405d56a43b1f035f40d53149fc8dabc321bbaf17b180eb9e3b1dda282cc2fd8675a3e10c8bc59a9f7a59
-  data.tar.gz: f9f28ad1537cc297a0b5b1fe8a5209d4f4dfa4529148a603f715da884fa9d9f8188836aca84c8e5dcc36f674bb6abe7211de57c014e90a4539d892da0192c28d
+  metadata.gz: e436f30e97f0a256d146539902b3f6fe9b54c241d7b49a51da63242f59505793c14f6ceef601343660750d0030ddf21c196e40a4aec41b1b5f1490b71b255ca6
+  data.tar.gz: 14095b912856efe2a097471046e518c0d3040320e72198ae28cf8b76c84040ca3319f16916ef2c70c357d8661e6465a36d7b80c49109896c828a2cc36dd777ee

data/README.md

@@ -1,4 +1,4 @@
-# Occams Record [![Build Status](https://travis-ci.org/jhollinger/occams-record.svg?branch=master)](https://travis-ci.org/jhollinger/occams-record)
+# Occams Record
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
@@ -284,7 +284,6 @@ The following ActiveRecord features are under consideration, but not high priori
 The following ActiveRecord features are not supported, and likely never will be. Pull requests are still welcome, though.
 
 * Eager loading `through` associations that involve a polymorphic association.
-* ActiveRecord enum types
 * ActiveRecord serialized types
 
 ---
@@ -299,32 +298,40 @@ On the other hand, Active Record makes it *very* easy to forget to eager load as
 
 # Testing
 
-```bash
-bundle install
-
-# test against SQLite
-bundle exec rake test
-
-# test against Postgres
-TEST_DATABASE_URL=postgresql://postgres@localhost:5432/occams_record bundle exec rake test
-
-# test against MySQL
-TEST_DATABASE_URL=mysql2://root:@127.0.0.1:3306/occams_record bundle exec rake test
-```
-
-**Test against all supported ActiveRecord versions**
+Tests are run with `appraisal` in Docker Compose using the `bin/test` or `bin/testall` scripts.
 
 ```bash
-bundle exec appraisal install
-
-# test against all supported AR versions (defaults to SQLite)
-bundle exec appraisal rake test
-
-# test against a specific AR version
-bundle exec appraisal ar-7.0 rake test
-
-# test against Postgres
-TEST_DATABASE_URL=postgresql://postgres@localhost:5432/occams_record bundle exec appraisal rake test
+# Run tests against all supported ActiveRecord versions, Ruby versions, and databases
+bin/testall
+
+# Run tests for Ruby vX only
+bin/testall ruby-3.1
+
+# Run tests for ActiveRecord vX only
+bin/testall ar-6.1
+
+# Run tests against a specific database
+bin/testall sqlite|postgres-14|mysql-8
+
+# Run exactly one set of tests
+bin/test ruby-3.1 ar-7.0 postgres-14
+
+# If all tests complete successfully, you'll be rewarded by an ASCII Nyancat!
+
++      o     +              o
+    +             o     +       +
+o          +
+    o  +           +        +
++        o     o       +        o
+-_-_-_-_-_-_-_,------,      o
+_-_-_-_-_-_-_-|   /\_/\
+-_-_-_-_-_-_-~|__( ^ .^)  +     +
+_-_-_-_-_-_-_-""  ""
+    +      o         o   +       o
+    +         +
+o        o         o      o     +
+    o           +
++      +     o        o      +
 ```
 
 # License

data/lib/occams-record/pluck.rb

@@ -2,14 +2,34 @@ module OccamsRecord
   module Pluck
     private
 
-    def pluck_results(results, cols)
+    def pluck_results(results, cols, model: nil)
       if cols.size == 1
-        col = cols[0].to_s
-        results.map { |r| r[col] }
+        pluck_results_single(results, cols[0].to_s, model: model)
       else
-        cols = cols.map(&:to_s)
-        results.map { |r| r.values_at(*cols) }
+        pluck_results_multi(results, cols.map(&:to_s), model: model)
       end
     end
+
+    # returns an array of values
+    def pluck_results_single(results, col, model: nil)
+      casters = TypeCaster.generate(results.columns, results.column_types, model: model)
+      col = results.columns[0]
+      caster = casters[col]
+      results.map { |row|
+        val = row[col]
+        caster ? caster.(val) : val
+      }
+    end
+
+    # returns an array of arrays
+    def pluck_results_multi(results, cols, model: nil)
+      casters = TypeCaster.generate(results.columns, results.column_types, model: model)
+      results.map { |row|
+        row.map { |col, val|
+          caster = casters[col]
+          caster ? caster.(val) : val
+        }
+      }
+    end
   end
 end

data/lib/occams-record/query.rb

@@ -250,7 +250,7 @@ module OccamsRecord
                else
                  model.connection.exec_query sql
                end
-      pluck_results result, cols
+      pluck_results result, cols, model: @model
     end
   end
 end

data/lib/occams-record/raw_query.rb

@@ -229,7 +229,7 @@ module OccamsRecord
                else
                  conn.exec_query _escaped_sql
                end
-      pluck_results result, cols
+      pluck_results result, cols, model: @eager_loaders.model
     end
 
     private

data/lib/occams-record/results/results.rb

@@ -1,13 +1,6 @@
 module OccamsRecord
   # Classes and methods for handing query results.
   module Results
-    # ActiveRecord's internal type casting API changes from version to version.
-    CASTER = case ActiveRecord::VERSION::MAJOR
-             when 4 then :type_cast_from_database
-             when 5, 6, 7 then :deserialize
-             else raise "OccamsRecord::Results::CASTER does yet support this version of ActiveRecord"
-             end
-
     #
     # Dynamically build a class for a specific set of result rows. It inherits from OccamsRecord::Results::Row, and optionall prepends
     # user-defined modules.
@@ -43,28 +36,22 @@ module OccamsRecord
         attr_accessor(*association_names)
 
         # Build a getter for each attribute returned by the query. The values will be type converted on demand.
-        model_column_types = model ? model.attributes_builder.types : nil
+        casters = TypeCaster.generate(column_names, column_types, model: model)
         self.columns.each_with_index do |col, idx|
-          #
-          # NOTE there's lots of variation between DB adapters and AR versions here. Some notes:
-          # * Postgres AR < 6.1 `column_types` will contain entries for every column.
-          # * Postgres AR >= 6.1 `column_types` only contains entries for "exotic" types. Columns with "common" types have already been converted by the PG adapter.
-          # * SQLite `column_types` will always be empty. Some types will have already been convered by the SQLite adapter, but others will depend on
-          #   `model_column_types` for converstion. See test/raw_query_test.rb#test_common_types for examples.
-          # * MySQL ?
-          #
-          type = column_types[col] || model_column_types&.[](col)
-          case type&.type
-          when nil
-            define_method(col) { @raw_values[idx] }
-          when :datetime
-            define_method(col) { @cast_values[idx] ||= type.send(CASTER, @raw_values[idx])&.in_time_zone }
-          when :boolean
-            define_method(col) { @cast_values[idx] ||= type.send(CASTER, @raw_values[idx]) }
-            define_method("#{col}?") { !!send(col) }
+          caster = casters[col]
+
+          if caster
+            define_method(col) {
+              @cast_values[idx] = caster.(@raw_values[idx]) if @cast_values[idx].nil?
+              @cast_values[idx]
+            }
           else
-            define_method(col) { @cast_values[idx] ||= type.send(CASTER, @raw_values[idx]) }
+            define_method(col) {
+              @raw_values[idx]
+            }
           end
+
+          define_method("#{col}?") { !!send(col) }
         end
       end
     end

data/lib/occams-record/results/row.rb

@@ -40,7 +40,7 @@ module OccamsRecord
       #
       # Hash-like accessor for attributes and associations.
       #
-      # @param attr [String|Symbol\
+      # @param attr [String|Symbol]
       # @return [Object]
       #
       def [](attr)

data/lib/occams-record/type_caster.rb

@@ -0,0 +1,60 @@
+module OccamsRecord
+  # @private
+  module TypeCaster
+    CASTER =
+      case ActiveRecord::VERSION::MAJOR
+      when 4 then :type_cast_from_database
+      when 5, 6, 7 then :deserialize
+      else raise "OccamsRecord::TypeCaster::CASTER does yet support this version of ActiveRecord"
+      end
+
+    #
+    # @param column_names [Array<String>] the column names in the result set. The order MUST match the order returned by the query.
+    # @param column_types [Hash] Column name => type from an ActiveRecord::Result
+    # @param model [ActiveRecord::Base] the AR model representing the table (it holds column & type info).
+    # @return [Hash<Proc>] a Hash of casting Proc's keyed by column
+    #
+    def self.generate(column_names, column_types, model: nil)
+      column_names.each_with_object({}) { |col, memo|
+        #
+        # NOTE there's lots of variation between DB adapters and AR versions here. Some notes:
+        # * Postgres AR < 6.1 `column_types` will contain entries for every column.
+        # * Postgres AR >= 6.1 `column_types` only contains entries for "exotic" types. Columns with "common" types have already been converted by the PG adapter.
+        # * SQLite `column_types` will always be empty. Some types will have already been convered by the SQLite adapter, but others will depend on
+        #   `model_column_types` for converstion. See test/raw_query_test.rb#test_common_types for examples.
+        # * MySQL ?
+        #
+        type = column_types[col] || model&.attributes_builder&.types&.[](col)
+
+        #
+        # NOTE is also some variation in when enum values are mapped in different AR versions.
+        # In >=5.0, <=7.0, ActiveRecord::Result objects *usually* contain the human-readable values. In 4.2 and
+        # pre-release versions of 7.1, they instead have the RAW values (e.g. integers) which we must map ourselves.
+        #
+        enum = model&.defined_enums&.[](col)
+        inv_enum = enum&.invert
+
+        memo[col] =
+          case type&.type
+          when nil
+            if enum
+              ->(val) { enum.has_key?(val) ? val : inv_enum[val] }
+            end
+          when :datetime
+            ->(val) { type.send(CASTER, val)&.in_time_zone }
+          when :boolean
+            ->(val) { type.send(CASTER, val) }
+          else
+            if enum
+              ->(val) {
+                val = type.send(CASTER, val)
+                enum.has_key?(val) ? val : inv_enum[val]
+              }
+            else
+              ->(val) { type.send(CASTER, val) }
+            end
+          end
+      }
+    end
+  end
+end

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # @private
-  VERSION = "1.7.1".freeze
+  VERSION = "1.8.1".freeze
 end

data/lib/occams-record.rb

@@ -3,6 +3,7 @@ require 'occams-record/version'
 require 'occams-record/merge'
 require 'occams-record/measureable'
 require 'occams-record/eager_loaders/eager_loaders'
+require 'occams-record/type_caster'
 require 'occams-record/results/results'
 require 'occams-record/results/row'
 require 'occams-record/pluck'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,20 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: A faster, lower-memory, fuller-featured querying API for ActiveRecord
   that returns results as unadorned, read-only objects.
 email: jordan.hollinger@gmail.com
@@ -79,6 +65,7 @@ files:
 - lib/occams-record/raw_query.rb
 - lib/occams-record/results/results.rb
 - lib/occams-record/results/row.rb
+- lib/occams-record/type_caster.rb
 - lib/occams-record/ugly.rb
 - lib/occams-record/version.rb
 homepage: https://jhollinger.github.io/occams-record/