introspective_grape 0.3.9 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1effbc66aaa2ba49bd62f0e7605095c7e827bf83
-  data.tar.gz: baebbb68b35036a66a2ff041f80c17b2d47decd1
+SHA256:
+  metadata.gz: dd8453af52e6616722a7899ace0e7b79c9e4129dea63565c99f8f7ba94f77ee9
+  data.tar.gz: 0e2c0a47ab78f79d37d9a9fec9c861c82421303205084b9168eff6f3a239af2a
 SHA512:
-  metadata.gz: 65d0d34c627d73ecdf3a082bc45f6597f9ae22aa066c0fa0eaea379d04ff4e38d9eca6bd5a8ef4fdfe03c44da3869bda89b7814e5a84cac8b9c0144416ead2de
-  data.tar.gz: 3733b34a24eb28826f9ae455b3975b6a96b5796ca78d75486bd4ee18a761370ce2fa847c6dae080e8486b79d062c2f0fbbc60f33e9781b871d676e7edf3da927
+  metadata.gz: b51e598d1078c423c809c68f75cb52079920ac06f4d4cc634814575c8f24af28296e05bc0de1e77383ece29ef30f03ce90c14d203dda51c6ad510a1fafadb7a3
+  data.tar.gz: d2916cb32f455dba2f083661c6c90a9190c54b9c10b8f5c8dc1c159f11a1a4227ae54c6b9878beb39a4cca7631095fc1539c4c0437dfc89a239880c854671dae

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.4.1 10/20/2020
+================
+
+We can't expect to ever release a 1.0 if the configuration object doesn't actually persist from the initializer.
+
+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

@@ -20,17 +20,16 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3'
 
-  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-entity'
-  s.add_dependency 'grape-swagger'
-  s.add_dependency 'kaminari' #, '< 1.0' # version 1.0.0 breaks
+  s.add_runtime_dependency "rails", '> 5.0.0'
+  s.add_runtime_dependency "rack", '< 2.0.9' # grape < 1.3.0 is incompatible with rack 2.1.0
+  s.add_runtime_dependency 'grape', ['~> 1.2.0', '< 1.2.5']
+  s.add_runtime_dependency 'grape-entity'
+  s.add_runtime_dependency 'grape-swagger'
+  s.add_runtime_dependency 'kaminari' #, '< 1.0' # version 1.0.0 breaks
   #s.add_dependency 'grape-kaminari', :github => 'alexey-klimuk/grape-kaminari'
   # Pundit 2.0 mysteriously made authorize a protected method...
-  s.add_dependency 'pundit' #, '<2.0'
-  s.add_dependency 'camel_snake_keys', '>0.0.4'
+  s.add_runtime_dependency 'pundit' #, '<2.0'
+  s.add_runtime_dependency 'camel_snake_keys', '>0.0.4'
 
   if RUBY_PLATFORM == 'java'
     #s.add_development_dependency "jdbc-sqlite3"

data/lib/introspective_grape.rb

@@ -1,6 +1,8 @@
+require 'introspective_grape/configuration'
 module IntrospectiveGrape
   autoload :API,            'introspective_grape/api'
   autoload :CamelSnake,     'introspective_grape/camel_snake'
+  autoload :Configure,      'introspective_grape/configuration'
   autoload :CreateHelpers,  'introspective_grape/create_helpers'
   autoload :Doc,            'introspective_grape/doc'
   autoload :Filters,        'introspective_grape/filters'
@@ -13,6 +15,6 @@ module IntrospectiveGrape
   end
 
   def self.config
-    @config = OpenStruct.new(camelize_parameters: true)
+    @config ||= Configuration.new
   end
 end

data/lib/introspective_grape/api.rb

@@ -248,9 +248,12 @@ module IntrospectiveGrape
 
           @model.update_attributes!( safe_params(params).permit(klass.whitelist) )
          
-          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/configuration.rb

@@ -0,0 +1,15 @@
+module IntrospectiveGrape
+  def self.configure
+    self.config ||= Configuration.new
+    yield config
+  end
+
+  class Configuration
+    attr_accessor :camelize_parameters, :skip_object_reload
+
+    def initialize
+      @camelize_parameters = true
+      @skip_object_reload  = false
+    end
+  end
+end

data/lib/introspective_grape/version.rb

@@ -1,3 +1,3 @@
 module IntrospectiveGrape
-  VERSION = "0.3.9".freeze
+  VERSION = "0.4.3".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.3
 platform: ruby
 authors:
 - Josh Buermann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.9
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +45,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 +55,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
@@ -241,6 +261,7 @@ files:
 - lib/introspective_grape.rb
 - lib/introspective_grape/api.rb
 - lib/introspective_grape/camel_snake.rb
+- lib/introspective_grape/configuration.rb
 - lib/introspective_grape/create_helpers.rb
 - lib/introspective_grape/doc.rb
 - lib/introspective_grape/filters.rb
@@ -398,7 +419,7 @@ homepage: https://github.com/buermann/introspective_grape
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -413,9 +434,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Introspectively configure deeply nested RESTful Grape APIs for ActiveRecord
   models.