introspective_grape 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1effbc66aaa2ba49bd62f0e7605095c7e827bf83
-  data.tar.gz: baebbb68b35036a66a2ff041f80c17b2d47decd1
+SHA256:
+  metadata.gz: d1070be152294dd627fb6f0e98038ae626412ddd716dd1ae97137de93b1b0d70
+  data.tar.gz: 12fe0f44356159f58a8482b297a4e2268b9a4da3281be1e8cd1599bd1d2f0bc0
 SHA512:
-  metadata.gz: 65d0d34c627d73ecdf3a082bc45f6597f9ae22aa066c0fa0eaea379d04ff4e38d9eca6bd5a8ef4fdfe03c44da3869bda89b7814e5a84cac8b9c0144416ead2de
-  data.tar.gz: 3733b34a24eb28826f9ae455b3975b6a96b5796ca78d75486bd4ee18a761370ce2fa847c6dae080e8486b79d062c2f0fbbc60f33e9781b871d676e7edf3da927
+  metadata.gz: 7d3086df6face4380f6596be5b9dea2dc61a72e3672c2e74a175e9236cd0a18fcac749e2eeef1a8df8724e232ac816c0ca9cdec425da7a3912c997a3f91b1037
+  data.tar.gz: eee38bbee623810f27dd48d925cc456abd3a6ccbcb8773cfb4945afea29aa5da92bc6f61cbd57601f0c5ed613b4f9c4a839621bc91f33e727282d66d96e4e9ff

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 
+0.4.0 10/20/2020
+================
+
+Add an `IntrospectiveGrape.config.skip_object_reload = true` option.
+
 0.3.9 04/01/2019
 ================
 

data/README.md

@@ -49,6 +49,8 @@ And bundle install.
 
 ## Grape Configuration
 
+### Camelization
+
 IntrospectiveGrape's default behavior is to camelize all outputs and snake case all inputs. To camel case all your json output you'll need to use its formatter in your API:
 
 ```
@@ -61,6 +63,18 @@ You can disable this behavior by setting `IntrospectiveGrape.config.camelize_par
 
 To include this behavior in your test coverage you need to either access the API's params hash or you can format the response body to `JSON.parse(response.body).with_snake_keys` in a helper method with the `using CamelSnakeKeys` refinement.
 
+### Reloading an object after an update request
+
+By default the gem reloads the object instance before presenting the updated model, a lazy but
+effective workaround to updates that may not propagate in the working instance due to actions
+a user may take in hooks, or some updates to has_many :through associations. We want to put up
+APIs with haste rather than digging our way out of tricky minutae that can be handled later as
+technical debt.
+
+This behavior can be disabled by setting `IntrospectiveGrape.config.skip_object_reload = true`,
+when you have time for technical debt you can toggle it and work on fixing broken tests (you
+did take the time to write comprehensive test coverage, didn't you?).
+
 ## Authentication and authorization
 
 Authentication and authorization are presently enforced on every endpoint. If you have named the authentication helper method in Grape something other than "authenticate!" or "authorize!" you can set it with:

data/introspective_grape.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", '> 5.0.0'
 
   # grape 1.0.0 breaks the pagination solution
-  s.add_dependency 'grape', '~> 1.2.0'
+  s.add_dependency 'grape', ['~> 1.2.0', '< 1.2.5']
   s.add_dependency 'grape-entity'
   s.add_dependency 'grape-swagger'
   s.add_dependency 'kaminari' #, '< 1.0' # version 1.0.0 breaks

data/lib/introspective_grape.rb

@@ -13,6 +13,6 @@ module IntrospectiveGrape
   end
 
   def self.config
-    @config = OpenStruct.new(camelize_parameters: true)
+    @config = OpenStruct.new(camelize_parameters: true, skip_object_reload: false)
   end
 end

data/lib/introspective_grape/api.rb

@@ -250,7 +250,12 @@ module IntrospectiveGrape
          
           default_includes = routes.first.klass.default_includes(routes.first.model)
 
-          present klass.find_leaf(routes, @model.class.includes(default_includes).find(@model.id), params), with: "#{klass}::#{model}Entity".constantize
+          if IntrospectiveGrape.config.skip_object_reload
+            present klass.find_leaf(routes, @model, params), with: "#{klass}::#{model}Entity".constantize
+          else
+            default_includes = routes.first.klass.default_includes(routes.first.model)
+            present klass.find_leaf(routes, @model.class.includes(default_includes).find(@model.id), params), with: "#{klass}::#{model}Entity".constantize
+          end
         end
       end
 

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.3.9".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: introspective_grape
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Buermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
@@ -413,8 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Introspectively configure deeply nested RESTful Grape APIs for ActiveRecord