remote_record 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b0ea2bc5ed71919334a2a22d53f70a38ad06b116c7e76679e76bb0aeeb9ec9c
-  data.tar.gz: 4874762ea7e61fc354e99faa8d4cf6e79ba9b1451dcf5eefb029e2c173911b13
+  metadata.gz: d657d0ec1a8c4606cc656d2c557e592637fa50d165cd95e118a8efa3094bc7a7
+  data.tar.gz: 6bd9609c2617e49b9701e84cd1011236978233856864791e7126c221228addf3
 SHA512:
-  metadata.gz: 603cbf7ecd366f2e3ba00c0be7d1ef793a484948a4940ddae511ab7e99583620d405cee4068958099dcf44aec52bdcc0df612771fc9b9243db530b643d5f1220
-  data.tar.gz: d5edee74efd6afd30db89d237674c5deb6953279636accc3e22b28b95e866f769631dc4a13fa70b30982e8f1422f2707bd9ccac2b0b1bdca2de5824e21e9c732
+  metadata.gz: 4a115d1e2e29d138e67a70c574d66cb7efca0c1ab239d9f47146d8e157410c68d700c8c4bf2c19db647d45a3831f669984117db4823b16691d53af07245ccec1
+  data.tar.gz: 7325785485edb863a7d5c91e10b80b8119c93c1ec8b5ff7b1f570ffd498ac297b4c1ba8e3e86549d19ba654e6a578dc2f705a0470fbc2c19aac9e6f5bf49d488

data/README.md

@@ -231,5 +231,19 @@ You might want to force a fresh request in some instances, even if you're using
 ### Skip fetching
 
 You might not want to make a request on initialize sometimes. In this case, pass
-`fetching: false` to your query or `new` to make sure the resource isn't
-fetched.
+`fetching: false` when creating or initializing references to make sure the
+resource isn't fetched.
+
+When querying for records using ActiveRecord alone, you might want to do so
+within a `no_fetching` context:
+
+```ruby
+TodoReference.no_fetching { |model| model.where(remote_resource_id: 1) }
+```
+
+Any records initialized within a `no_fetching` context won't be requested. It's
+sort of like a `Faraday` cage, pun entirely intended.
+
+If you're using `remote_all` or `remote_where` to fetch using your API, that'll
+automatically use this behind the scenes, then set `attrs` to the response
+value.

data/lib/remote_record/base.rb

@@ -41,6 +41,10 @@ module RemoteRecord
       @attrs.update(get)
     end
 
+    def attrs=(new_attrs)
+      @attrs.update(new_attrs)
+    end
+
     private
 
     def transform(data)

data/lib/remote_record/reference.rb

@@ -9,7 +9,9 @@ module RemoteRecord
   module Reference
     extend ActiveSupport::Concern
 
-    class_methods do
+    class_methods do # rubocop:disable Metrics/BlockLength
+      attr_accessor :fetching
+
       def remote_record_class
         ClassLookup.new(self).remote_record_class(
           remote_record_config.to_h[:remote_record_class]&.to_s
@@ -24,15 +26,36 @@ module RemoteRecord
         Config.new
       end
 
+      def fetching
+        @fetching = true if @fetching.nil?
+        @fetching
+      end
+
+      # Disable fetching for all records initialized in the block.
+      def no_fetching
+        self.fetching = false
+        block_return_value = yield(self)
+        self.fetching = true
+        block_return_value
+      end
+
       def remote_all(&authz_proc)
-        remote_record_class.all(&authz_proc).map do |remote_resource|
-          where(remote_resource_id: remote_resource['id']).first_or_initialize(initial_attrs: remote_resource)
+        no_fetching do
+          remote_record_class.all(&authz_proc).map do |remote_resource|
+            where(remote_resource_id: remote_resource['id']).first_or_initialize.tap do |record|
+              record.attrs = remote_resource
+            end
+          end
         end
       end
 
       def remote_where(params, &authz_proc)
-        remote_record_class.where(params, &authz_proc).map do |remote_resource|
-          where(remote_resource_id: remote_resource['id']).first_or_initialize(initial_attrs: remote_resource)
+        no_fetching do
+          remote_record_class.where(params, &authz_proc).map do |remote_resource|
+            where(remote_resource_id: remote_resource['id']).first_or_initialize.tap do |record|
+              record.attrs = remote_resource
+            end
+          end
         end
       end
     end
@@ -40,11 +63,10 @@ module RemoteRecord
     # rubocop:disable Metrics/BlockLength
     included do
       include ActiveSupport::Rescuable
-      attr_accessor :fetching
+      attribute :fetching, :boolean, default: -> { fetching }
       attr_accessor :initial_attrs
 
       after_initialize do |reference|
-        reference.fetching = true if reference.fetching.nil?
         reference.fetching = false if reference.initial_attrs.present?
         config = reference.class.remote_record_class.default_config.merge(
           reference.class.remote_record_config.to_h
@@ -82,6 +104,8 @@ module RemoteRecord
 
       private
 
+      delegate :attrs=, to: :@instance
+
       def instance
         @instance ||= @remote_record_config.remote_record_class.new(self, @remote_record_config)
       end

data/lib/remote_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteRecord
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remote_record
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Simon Fish
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord