occams-record 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ceea75487deeadf930b9236a44980882ac539042e9d86b6ce5612da9c58642c
-  data.tar.gz: 190dab76b6f35d430f97a4be25ccf3fe56b652edb9722c83de844cd5c9d1715e
+  metadata.gz: a1e01657287159a2aa1a27ff66c1932ae83235ad0140dbaafd58103862ddaa8f
+  data.tar.gz: ec9530c3844cd79739d1a2387031654e85f4a2a127d948df0c537431aa235ed5
 SHA512:
-  metadata.gz: 384fcddbac59eb4663a0e4d8f3f7c0286f8ff348c5b37e74c5f052fca5138011f06a107a5b305d57df1391bf581b35605346ee11a9e5d6542af0e2298e3e0273
-  data.tar.gz: 49e71a3dd7eb5bd78180b17ba01550e7105450fdeee2ff6bbbae255fbb3f11eac1182bc233caff5567449723b45c24ed8e465a2bee0b28523ebcc74904280956
+  metadata.gz: a0303147fa894e42d0642020a4a207c67b3a79fa3fc2dfa1b9be819224c8eee6bb261bfa2079a073cd1894f744b4995f307afff594f458c5b7ae7574b26b0d32
+  data.tar.gz: bf81dc3eeb78cbf9ed99740a1c4c8e1c71287f4af278c2a623d9220384460f952ccc50fa835393ef3fd416fa0019fccc6a6e41d0c8dbd77c637f08689ca5c585

data/README.md

@@ -97,6 +97,8 @@ gem 'occams-record'
 
 Full documentation is available at [rubydoc.info/gems/occams-record](http://www.rubydoc.info/gems/occams-record).
 
+Code lives at at [github.com/jhollinger/occams-record](https://github.com/jhollinger/occams-record). Contributions welcome!
+
 Build your queries like normal, using ActiveRecord's excellent query builder. Then pass them off to Occams Record.
 
 ```ruby
@@ -290,30 +292,26 @@ On the other hand, Active Record makes it *very* easy to forget to eager load as
 
 # Testing
 
-To run the tests, simply run:
-
 ```bash
 bundle install
-bundle exec rake test
-```
-
-**Specify ActiveRecord version**
 
-By default, bundler will install the latest (supported) version of ActiveRecord. To specify a version to test against, run:
+# test against SQLite
+bundle exec rake test
 
-```bash
-AR=5.2 bundle update activerecord
-AR=5.2 bundle exec rake test
+# test against Postgres
+TEST_DATABASE_URL=postgres://postgres@localhost:5432/occams_record bundle exec rake test
 ```
 
-Look inside `Gemfile` to see all testable versions.
+**Test against all supported ActiveRecord versions**
 
-**Run against Postgres**
+```bash
+bundle exec appraisal install
 
-By default the tests run against an in-memory Sqlite3 database. Use the following env var to force running against a Postgres database:
+# test against SQLite
+bundle exec appraisal rake test
 
-```bash
-TEST_DATABASE_URL=postgres://postgres@localhost:5432/occams_record bundle exec rake test
+# test against Postgres
+TEST_DATABASE_URL=postgres://postgres@localhost:5432/occams_record bundle exec appraisal rake test
 ```
 
 # License

data/lib/occams-record/connection.rb

@@ -0,0 +1,7 @@
+module OccamsRecord
+  class Connection
+    def initialize(model, role = nil)
+      @model, @role = model, role
+    end
+  end
+end

data/lib/occams-record/raw_query.rb

@@ -4,7 +4,7 @@ module OccamsRecord
   # a Hash of binds. While this doesn't offer an additional performance boost, it's a nice way to
   # write safe, complicated SQL by hand while also supporting eager loading.
   #
-  #   results = OccamsRecord.sql(
+  #   results = OccamsRecord.sql("
   #     SELECT * FROM widgets
   #     WHERE category_id = %{cat_id}
   #   ", {
@@ -13,7 +13,6 @@ module OccamsRecord
   #
   # If you want to do eager loading, you must first the define a model to pull the associations from (unless
   # you're using the raw SQL eager loaders `eager_load_one` or `eager_load_many`).
-  # NOTE If you're using SQLite, you must *always* specify the model.
   #
   #   results = OccamsRecord.
   #     sql("
@@ -27,8 +26,20 @@ module OccamsRecord
   #     run
   #
   # NOTE To use find_each/find_in_batches, your SQL string must include 'LIMIT %{batch_limit} OFFSET %{batch_offset}',
-  # and an ORDER BY is strongly recomended.
-  # OccamsRecord will provide the bind values for you.
+  # and an ORDER BY is strongly recomended. OccamsRecord will provide the bind values for you.
+  #
+  # NOTE There is variation of the types of values returned (e.g. a Date object vs a date string) depending on the database
+  # and ActiveRecord version being used:
+  #
+  # Postgres always returns native Ruby types.
+  #
+  # SQLite will return native types for the following: integers, floats, string/text.
+  # For booleans it will return 0|1 for AR 6+, and "t|f" for AR 5-.
+  # Dates and times will be ISO8601 formatted strings.
+  # It is possible to coerce the SQLite adapter into returning native types for everything IF they're columns of a table
+  # that you have an AR model for. e.g. if you're selecting from the widgets, table: `OccamsRecord.sql("...").model(Widget)...`.
+  #
+  # MySQL ?
   #
   # @param sql [String] The SELECT statement to run. Binds should use Ruby's named string substitution.
   # @param binds [Hash] Bind values (Symbol keys)

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

@@ -36,14 +36,20 @@ 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 : {}
+        model_column_types = model ? model.attributes_builder.types : nil
         self.columns.each_with_index do |col, idx|
-          type =
-            column_types[col] ||
-            model_column_types[col] ||
-            raise("OccamsRecord: Column `#{col}` does not exist on model `#{self.model_name}`")
-
-          case type.type
+          #
+          # 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

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = "1.2.0".freeze
+  VERSION = "1.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.2'
+- !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 querying API for ActiveRecord that returns results
   as unadorned, read-only objects.
 email: jordan.hollinger@gmail.com
@@ -40,6 +54,7 @@ files:
 - README.md
 - lib/occams-record.rb
 - lib/occams-record/batches.rb
+- lib/occams-record/connection.rb
 - lib/occams-record/eager_loaders/ad_hoc_base.rb
 - lib/occams-record/eager_loaders/ad_hoc_many.rb
 - lib/occams-record/eager_loaders/ad_hoc_one.rb