occams-record 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4835c655a7c4f9e68b567bc5727d9d99c13e638bb457a7615bb5ee598ae0499b
-  data.tar.gz: 7a3ec8be97cbcb06f1b74bfd5e55e163b2fd6bacd163764551581ccdee92f16f
+  metadata.gz: 1731e8d0d0a676f2f94e5b019795eb3a1d5560be4e66f1d38df73cb876946de0
+  data.tar.gz: 92af45a6d871c13a344926319fd26a45380a3f0527ac1d3fda6f042885cb00bc
 SHA512:
-  metadata.gz: b38f0a2f9fb329ee1ea9d0fe098a9dc8854744effef9f6699209b5375e2cd1f68b2dcb557821c074653396ad4607db75f38c054b2b72b3736714a13b3ea49050
-  data.tar.gz: 5c9869505a2bf795156252e81871166fa0a5818798cae9ad51d6a1099938fd3a3e00922aabd22259f4073f0f8f68f4d5cb83f27bed58d01bc02a1b793e48ac99
+  metadata.gz: df7d5ebd7e07c4bc75ae4e895f9d362fb99ff6cfb56e24ad6d8cfc4c7b3bcd3e63e5af943573f818988be0ff0083ba2f62094c0375feb97776860fbc59f7f018
+  data.tar.gz: 7c7b58321d235b00c00da9f77fcd1275e92358ddbce580e12795dd0eb6c4dc6eabd752ebe85d89e48ba7ea52b66a49566a9028822ca926f9d0c93ede32feac84

data/lib/occams-record.rb

@@ -5,3 +5,4 @@ require 'occams-record/eager_loaders'
 require 'occams-record/results'
 require 'occams-record/query'
 require 'occams-record/raw_query'
+require 'occams-record/errors'

data/lib/occams-record/eager_loaders.rb

@@ -117,7 +117,7 @@ module OccamsRecord
         when :has_many
           HasMany
         when :has_and_belongs_to_many
-          EagerLoaders::Habtm
+          Habtm
         else
           raise "Unsupported association type `#{macro}`"
         end

data/lib/occams-record/eager_loaders/ad_hoc_base.rb

@@ -49,7 +49,13 @@ module OccamsRecord
       # @yield
       #
       def calc_ids(rows)
-        ids = rows.map { |r| r.send @foreign_key }.compact.uniq
+        ids = rows.map { |row|
+          begin
+            row.send @foreign_key
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
+        }.compact.uniq
         yield ids
       end
 

data/lib/occams-record/eager_loaders/base.rb

@@ -55,8 +55,6 @@ module OccamsRecord
         raise 'Not Implemented'
       end
 
-      private
-
       #
       # Returns the base scope for the relation, including any scope defined on the association itself,
       # and any optional scope passed into the eager loader.

data/lib/occams-record/eager_loaders/belongs_to.rb

@@ -11,7 +11,13 @@ module OccamsRecord
       # @yield
       #
       def query(rows)
-        ids = rows.map { |r| r.send @ref.foreign_key }.compact.uniq
+        ids = rows.map { |row|
+          begin
+            row.send @ref.foreign_key
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
+        }.compact.uniq
         yield base_scope.where(@ref.active_record_primary_key => ids) if ids.any?
       end
 

data/lib/occams-record/eager_loaders/habtm.rb

@@ -30,14 +30,22 @@ module OccamsRecord
         }
 
         assoc_rows_by_id = assoc_rows.reduce({}) { |a, row|
-          id = row.send(@ref.association_primary_key).to_s
+          begin
+            id = row.send(@ref.association_primary_key).to_s
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
           a[id] = row
           a
         }
 
         assign = "#{name}="
         rows.each do |row|
-          id = row.send(@ref.active_record_primary_key).to_s
+          begin
+            id = row.send(@ref.active_record_primary_key).to_s
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
           assoc_fkeys = (joins_by_id[id] || []).uniq
           associations = assoc_rows_by_id.values_at(*assoc_fkeys).compact.uniq
           row.send assign, associations
@@ -59,7 +67,14 @@ module OccamsRecord
         join_table = conn.quote_table_name @ref.join_table
         assoc_fkey = conn.quote_column_name @ref.association_foreign_key
         fkey = conn.quote_column_name @ref.foreign_key
-        quoted_ids = rows.map { |r| conn.quote r.send @ref.active_record_primary_key }
+        quoted_ids = rows.map { |row|
+          begin
+            id = row.send @ref.active_record_primary_key
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
+          conn.quote id
+        }
 
         @join_rows = conn.
           exec_query("SELECT #{fkey}, #{assoc_fkey} FROM #{join_table} WHERE #{fkey} IN (#{quoted_ids.join ','})").

data/lib/occams-record/eager_loaders/has_one.rb

@@ -12,7 +12,13 @@ module OccamsRecord
       #
       def query(rows)
         return if rows.empty?
-        ids = rows.map { |r| r.send @ref.active_record_primary_key }.compact.uniq
+        ids = rows.map { |row|
+          begin
+            row.send @ref.active_record_primary_key
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
+        }.compact.uniq
         q = base_scope.where(@ref.foreign_key => ids)
         q.where!(@ref.type => rows[0].class&.model_name) if @ref.options[:as]
         yield q if ids.any?

data/lib/occams-record/eager_loaders/polymorphic_belongs_to.rb

@@ -57,7 +57,13 @@ module OccamsRecord
       def merge!(assoc_rows_of_type, rows)
         return if assoc_rows_of_type.empty?
         type = assoc_rows_of_type[0].class.model_name
-        rows_of_type = rows.select { |r| r.send(@foreign_type) == type }
+        rows_of_type = rows.select { |row|
+          begin
+            row.send(@foreign_type) == type
+          rescue NoMethodError => e
+            raise MissingColumnError.new(row, e.name)
+          end
+        }
         model = type.constantize
         Merge.new(rows_of_type, name).
           single!(assoc_rows_of_type, @ref.foreign_key.to_s, model.primary_key.to_s)

data/lib/occams-record/errors.rb

@@ -0,0 +1,34 @@
+module OccamsRecord
+  # Exception raised when a record wasn't loaded with all requested data
+  class MissingDataError < StandardError
+    # @return [String]
+    attr_reader :model_name
+    # @return [OccamsRecord::Result::Row]
+    attr_reader :record
+    # @return [Symbol]
+    attr_reader :name
+
+    # @param record [OccamsRecord::Result::Row]
+    # @param name [Symbol]
+    def initialize(record, name)
+      @record, @name = record, name
+      @model_name = record.class.model_name
+    end
+  end
+
+  # Exception when an unselected column is called on a result row
+  class MissingColumnError < MissingDataError
+    # @return [String]
+    def message
+      "Column '#{name}' is unavailable on #{model_name} because it was not included in the SELECT statement!"
+    end
+  end
+
+  # Exception when an unloaded association is called on a result row
+  class MissingEagerLoadError < MissingDataError
+    # @return [String]
+    def message
+      "Association '#{name}' is unavailable on #{model_name} because it was not eager loaded!"
+    end
+  end
+end

data/lib/occams-record/merge.rb

@@ -9,25 +9,6 @@ module OccamsRecord
     # @return [Array<OccamsRecord::Results::Row>] the rows into which associated rows will be merged
     attr_reader :target_rows
 
-    # Exception raised when a foreign or primary key is missing from a record
-    class MissingFieldError < StandardError
-      # @return [OccamsRecord::Result::Row]
-      attr_reader :record
-      # @return [Symbol]
-      attr_reader :field
-
-      # @param record [OccamsRecord::Result::Row]
-      # @param field [Symbol]
-      def initialize(record, field)
-        @record, @field = record, field
-      end
-
-      # @return [String]
-      def message
-        "Missing field '#{field}' on #{record.inspect}. Did you forget to select it?"
-      end
-    end
-
     #
     # Initialize a new Merge operation.
     #
@@ -52,7 +33,7 @@ module OccamsRecord
         begin
           id = assoc_row.send assoc_attr
         rescue NoMethodError => e
-          raise MissingFieldError.new(assoc_row, e.name)
+          raise MissingColumnError.new(assoc_row, e.name)
         end
         a[id] = assoc_row
         a
@@ -62,7 +43,7 @@ module OccamsRecord
         begin
           attr = row.send target_attr
         rescue NoMethodError => e
-          raise MissingFieldError.new(row, e.name)
+          raise MissingColumnError.new(row, e.name)
         end
         row.send @assign, attr ? assoc_rows_by_id[attr] : nil
       end
@@ -77,14 +58,14 @@ module OccamsRecord
       begin
         assoc_rows_by_attr = assoc_rows.group_by(&assoc_attr.to_sym)
       rescue NoMethodError => e
-        raise MissingFieldError.new(assoc_rows[0], e.name)
+        raise MissingColumnError.new(assoc_rows[0], e.name)
       end
 
       target_rows.each do |row|
         begin
           pkey = row.send target_attr
         rescue NoMethodError => e
-          raise MissingFieldError.new(row, e.name)
+          raise MissingColumnError.new(row, e.name)
         end
         row.send @assign, assoc_rows_by_attr[pkey] || []
       end

data/lib/occams-record/query.rb

@@ -60,10 +60,25 @@ module OccamsRecord
     #
     # Run the query and return the results.
     #
+    # You may optionally pass a block to modify the query just before it's run (the change will NOT persist).
+    # This is very useful for running paginated queries.
+    #
+    #   occams = OccamsRecord.query(Widget.all)
+    #
+    #   # returns first 100 rows
+    #   occams.run { |q| q.offset(0).limit(100) }
+    #
+    #   # returns second 100 rows
+    #   occams.run { |q| q.offset(100).limit(100) }
+    #
+    #   # returns ALL rows
+    #   occams.run
+    #
     # @return [Array<OccamsRecord::Results::Row>]
+    # @yield [ActiveRecord::Relation] You may use this to return and run a modified relation
     #
     def run
-      sql = scope.to_sql
+      sql = block_given? ? yield(scope).to_sql : scope.to_sql
       @query_logger << sql if @query_logger
       result = model.connection.exec_query sql
       row_class = OccamsRecord::Results.klass(result.columns, result.column_types, @eager_loaders.map(&:name), model: model, modules: @use)
@@ -74,6 +89,15 @@ module OccamsRecord
 
     alias_method :to_a, :run
 
+    #
+    # Returns the number of rows that will be returned if the query is run.
+    #
+    # @return [Integer]
+    #
+    def count
+      scope.count
+    end
+
     #
     # Run the query and return the first result (which could be nil). This WILL append a LIMIT 1 to the query.
     #

data/lib/occams-record/results.rb

@@ -107,9 +107,9 @@ module OccamsRecord
         model = self.class.model_name.constantize
 
         if model.reflections.has_key? name.to_s
-          raise MissingEagerLoadError.new(model.name, name)
+          raise MissingEagerLoadError.new(self, name)
         elsif model.columns_hash.has_key? name.to_s
-          raise MissingColumnSelectError.new(model.name, name)
+          raise MissingColumnError.new(self, name)
         else
           super
         end
@@ -124,33 +124,5 @@ module OccamsRecord
         "#<OccamsRecord::Results::Row @model_name=#{self.class.model_name} @raw_values=#{@raw_values}>"
       end
     end
-
-    # Exception when an unloaded association is called on a result row
-    class MissingEagerLoadError < StandardError
-      attr_reader :model_name
-      attr_reader :name
-
-      def initialize(model_name, name)
-        @model_name, @name = model_name, name
-      end
-
-      def message
-        "The association '#{name}' is unavailable on #{model_name} because it has not been eager loaded!"
-      end
-    end
-
-    # Exception when an unselected column is called on a result row
-    class MissingColumnSelectError < StandardError
-      attr_reader :model_name
-      attr_reader :name
-
-      def initialize(model_name, name)
-        @model_name, @name = model_name, name
-      end
-
-      def message
-        "The column '#{name}' is unavailable on #{model_name} because it was not included in the SELECT statement!"
-      end
-    end
   end
 end

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.20.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -50,6 +50,7 @@ files:
 - lib/occams-record/eager_loaders/has_many.rb
 - lib/occams-record/eager_loaders/has_one.rb
 - lib/occams-record/eager_loaders/polymorphic_belongs_to.rb
+- lib/occams-record/errors.rb
 - lib/occams-record/merge.rb
 - lib/occams-record/query.rb
 - lib/occams-record/raw_query.rb