occams-record 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a233847b8c1a9de8c77e8c5e1d12f70ea7c8b9efa498208491a17ff09a6f217
-  data.tar.gz: f87fbaf43703cd29b60b94a480ad903d00cad2b9b3bd9bfb4a77b7748f68aa81
+  metadata.gz: 5f2590ba264934763d86310d4cd9b92459cb053589afa23fb4ea4c4b423f2eb7
+  data.tar.gz: abb8aad716399e6b87d351e33a8f9ff629256964aed2f131795255cec3353b2a
 SHA512:
-  metadata.gz: 21115e90f5f455eaf33d5c0596d6276957905fb14932583fcdfacdb1a44f7afeaee029458de903fa58c2801e7504643c6c6e4a530822409ff93da6954648a06e
-  data.tar.gz: a38eba237379a4a0b55d027746a8796f9aa9904e60bb1ba6acd6fd46348fc84e0aef17fc6de482d5b32d6677c09b2ea53602b000bf6da9a60d5bd2dec0e72b3f
+  metadata.gz: 2aa46cce2b26cd5a6e0219651dcdace5391a7a1b67ae5d4e6c3a9a849c6b12a63a2c913208af0ae58d5e7c7ce6880fdc2c1081a3a4b7582b2a8300f76548c0e3
+  data.tar.gz: c3cdc38d42b7c97894bbe34215e9a8143209732c78fd8b5d8351932d5e7290783ec8239c8f5c21e6fa4f2f36325b97a76088953a9b0a28a7fd71c697aaa91993

data/README.md

@@ -2,6 +2,8 @@
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
+Full documentation is available at [rubydoc.info/gems/occams-record](http://www.rubydoc.info/gems/occams-record).
+
 OccamsRecord is a high-efficiency, advanced query library for use alongside ActiveRecord. It is **not** an ORM or an ActiveRecord replacement. OccamsRecord can breathe fresh life into your ActiveRecord app by giving it two things:
 
 ### 1) Huge performance gains
@@ -73,6 +75,17 @@ OccamsRecord
   .eager_load(:orders)
 ```
 
+**Use `pluck` with raw SQL**
+
+```ruby
+OccamsRecord
+  .sql("
+    SELECT some_col FROM users
+    INNER JOIN ...
+  ")
+  .pluck(:some_col)
+```
+
 **Eager load "ad hoc associations" using raw SQL**
 
 Relationships are complicated, and sometimes they can't be expressed in ActiveRecord models. Define your relationship on the fly!

data/lib/occams-record/pluck.rb

@@ -0,0 +1,15 @@
+module OccamsRecord
+  module Pluck
+    private
+
+    def pluck_results(results, cols)
+      if cols.size == 1
+        col = cols[0].to_s
+        results.map { |r| r[col] }
+      else
+        cols = cols.map(&:to_s)
+        results.map { |r| r.values_at(*cols) }
+      end
+    end
+  end
+end

data/lib/occams-record/query.rb

@@ -36,6 +36,7 @@ module OccamsRecord
     attr_reader :scope
 
     include OccamsRecord::Batches::CursorHelpers
+    include OccamsRecord::Pluck
     include EagerLoaders::Builder
     include Enumerable
     include Measureable
@@ -225,5 +226,27 @@ module OccamsRecord
         use: @use, query_logger: @query_logger, eager_loaders: @eager_loaders,
       )
     end
+
+    #
+    # Returns the specified column(s) as an array of values.
+    #
+    # If more than one column is given, the result will be an array of arrays.
+    #
+    # @param cols [Array] one or more column names as Symbols or Strings. Also accepts SQL functions, e.g. "LENGTH(name)".
+    # @return [Array]
+    #
+    def pluck(*cols)
+      sql = (block_given? ? yield(scope).to_sql : scope).select(*cols).to_sql
+      @query_logger << "#{@eager_loaders.tracer}: #{sql}" if @query_logger
+      result = if measure?
+                 record_start_time!
+                 measure!(model.table_name, sql) {
+                   model.connection.exec_query sql
+                 }
+               else
+                 model.connection.exec_query sql
+               end
+      pluck_results result, cols
+    end
   end
 end

data/lib/occams-record/raw_query.rb

@@ -62,6 +62,7 @@ module OccamsRecord
     attr_reader :binds
 
     include OccamsRecord::Batches::CursorHelpers
+    include OccamsRecord::Pluck
     include EagerLoaders::Builder
     include Enumerable
     include Measureable
@@ -209,6 +210,28 @@ module OccamsRecord
       )
     end
 
+    #
+    # Returns the specified column(s) as an array of values.
+    #
+    # If more than one column is given, the result will be an array of arrays.
+    #
+    # @param cols [Array] one or more column names as Symbols or Strings. Also accepts SQL functions, e.g. "LENGTH(name)".
+    # @return [Array]
+    #
+    def pluck(*cols)
+      _escaped_sql = escaped_sql
+      @query_logger << _escaped_sql if @query_logger
+      result = if measure?
+                 record_start_time!
+                 measure!(table_name, _escaped_sql) {
+                   conn.exec_query _escaped_sql
+                 }
+               else
+                 conn.exec_query _escaped_sql
+               end
+      pluck_results result, cols
+    end
+
     private
 
     # Returns the SQL as a String with all variables escaped

data/lib/occams-record/version.rb

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

data/lib/occams-record.rb

@@ -5,6 +5,7 @@ require 'occams-record/measureable'
 require 'occams-record/eager_loaders/eager_loaders'
 require 'occams-record/results/results'
 require 'occams-record/results/row'
+require 'occams-record/pluck'
 require 'occams-record/cursor'
 require 'occams-record/errors'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -74,6 +74,7 @@ files:
 - lib/occams-record/errors.rb
 - lib/occams-record/measureable.rb
 - lib/occams-record/merge.rb
+- lib/occams-record/pluck.rb
 - lib/occams-record/query.rb
 - lib/occams-record/raw_query.rb
 - lib/occams-record/results/results.rb