occams-record 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6122accb864f31c103a6036c8c3b9e08b457b52f
-  data.tar.gz: f8ed00235fc026d24a56a9f44065a45142472603
+SHA256:
+  metadata.gz: f01a553f2a0d8dcb7e2efaac70088239a05de6633375b8bf3f5c1f77a43808c8
+  data.tar.gz: 38095dbb827e293088f515e04bfdb907f088e1bddce0cfdc43f38455e8bafab4
 SHA512:
-  metadata.gz: 1f6a942bc993990b22448507ed25723a12a3a2a7d06d5684008b3a78a51f676b973cb11297f2a6818a9becd3164db5079181ae0566251cd8b8a2eee1b99fc763
-  data.tar.gz: 40f46acd684737a8214f7b06ce1dce31de0fc76bcc1f8ab4ee152973d6223f8089e416cec4536c9e567ac3c2ea292429a87cef898bcb059f05210d84285ff55a
+  metadata.gz: c221f51d83965ef207975806a2d5d7b4c6867ba7e1f2f9f08e2c2b78320de262d7863cfc1c215b37a12d5716b99377b2ee43d5697284e7e483f81f110572581b
+  data.tar.gz: 37c429c2af89af793ad80bbf87fe4b8083626d540e78cfb4887ffb3eb83c6d4019a4abfc26daf438a58256a36a136d2918d04499eb390cabf62016bf8da97208

data/README.md

@@ -48,11 +48,11 @@ orders = OccamsRecord.
   run
 ````
 
-`each`, `map`, `reduce`, and all other Enumerable methods are supported. `find_each` and `find_in_batches` are also supported, and unlike their ActiveRecord counterparts they respect *ORDER BY*. Occams Record has great support for raw SQL queries too, but we'll get to those later.
+`each`, `map`, `reduce`, and other Enumerable methods may be used instead of *run*. `find_each` and `find_in_batches` are also supported. Unlike their ActiveRecord counterparts they respect *ORDER BY*. Occams Record has great support for raw SQL queries too, but we'll get to those later.
 
 ## Basic eager loading
 
-Eager loading is similiar to ActiveRecord's `preload` (each association is loaded in a separate query). Nested associations use blocks instead of Hashes.
+Eager loading is similiar to ActiveRecord's `preload` (each association is loaded in a separate query). Nested associations use blocks instead of Hashes. And if you try to use an association you didn't eager load an exception will be raised.
 
 ```ruby
 orders = OccamsRecord.

data/lib/occams-record/errors.rb

@@ -31,4 +31,23 @@ module OccamsRecord
       "Association '#{name}' is unavailable on #{model_name} because it was not eager loaded!"
     end
   end
+
+  # Exception when a requested record couldn't be found.
+  class NotFound < StandardError
+    # @return [String]
+    attr_reader :model_name
+    # @return [Hash]
+    attr_reader :attrs
+
+    # @param model_name [String]
+    # @param attrs [Hash]
+    def initialize(model_name, attrs)
+      @model_name, @attrs = model_name, attrs
+    end
+
+    # @return [String]
+    def message
+      "#{model_name} could not be found with #{attrs}!"
+    end
+  end
 end

data/lib/occams-record/query.rb

@@ -100,7 +100,7 @@ module OccamsRecord
     end
 
     #
-    # Run the query and return the first result (which could be nil) by using LIMIT 1.
+    # Run the query with LIMIT 1 and return the first result (which could be nil).
     #
     # @return [OccamsRecord::Results::Row]
     #
@@ -108,6 +108,16 @@ module OccamsRecord
       run { |q| q.limit 1 }.first
     end
 
+    #
+    # Run the query with LIMIT 1 and return the first result. If nothing is found
+    # an OccamsRecord::NotFound exception will be raised.
+    #
+    # @return [OccamsRecord::Results::Row]
+    #
+    def first!
+      first || raise(OccamsRecord::NotFound.new(model.name, scope.where_values_hash))
+    end
+
     #
     # If you pass a block, each result row will be yielded to it. If you don't,
     # an Enumerable will be returned.

data/lib/occams-record/raw_query.rb

@@ -106,15 +106,6 @@ module OccamsRecord
 
     alias_method :to_a, :run
 
-    #
-    # Run the query and return the first result (which could be nil). IMPORTANT you MUST add LIMIT 1 yourself!
-    #
-    # @return [OccamsRecord::Results::Row]
-    #
-    def first
-      run[0]
-    end
-
     #
     # If you pass a block, each result row will be yielded to it. If you don't,
     # an Enumerable will be returned.

data/lib/occams-record/results.rb

@@ -84,6 +84,16 @@ module OccamsRecord
         @cast_values = {}
       end
 
+      #
+      # Hash-like accessor for attributes and associations.
+      #
+      # @param attr [String|Symbol\
+      # @return [Object]
+      #
+      def [](attr)
+        respond_to?(attr) ? send(attr) : nil
+      end
+
       #
       # Returns true if the two objects are from the same table and have the same primary key.
       #
@@ -99,13 +109,13 @@ module OccamsRecord
       end
 
       #
-      # Return row as a Hash (recursive).
+      # Return row as a Hash. By default the hash does NOT include associations.
       #
       # @param symbolize_names [Boolean] if true, make Hash keys Symbols instead of Strings
-      # @param recursive [Boolean] if true, convert all associated records to Hashes too
+      # @param recursive [Boolean] if true, include assiciations and them (and their associations) to hashes.
       # @return [Hash] a Hash with String or Symbol keys
       #
-      def to_h(symbolize_names: false, recursive: true)
+      def to_h(symbolize_names: false, recursive: false)
         hash = self.class.columns.reduce({}) { |a, col_name|
           key = symbolize_names ? col_name.to_sym : col_name
           a[key] = send col_name
@@ -116,9 +126,9 @@ module OccamsRecord
           key = symbolize_names ? assoc_name.to_sym : assoc_name
           assoc = send assoc_name
           a[key] = if assoc.is_a? Array
-                     assoc.map { |x| x.to_h(symbolize_names: symbolize_names) }
+                     assoc.map { |x| x.to_h(symbolize_names: symbolize_names, recursive: true) }
                    elsif assoc
-                     assoc.to_h(symbolize_names: symbolize_names)
+                     assoc.to_h(symbolize_names: symbolize_names, recursive: true)
                    end
           a
         } : hash

data/lib/occams-record/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-28 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: The missing high-efficiency query API for ActiveRecord