introspective_grape 0.5.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d29e073d96e9a6f2569eeaec65ece289f344fd5f0b6ea88a0dfb345d36d51052
-  data.tar.gz: dac77dd6bc6812de00ec06ee5299c5cea5ff0f3539a304e6a1d1335f72e69f36
+  metadata.gz: 6ec4b919395ffd2b409a4a4b93f223aa10406fef2886f33cc5b8d9ec89e3822b
+  data.tar.gz: 7269f346109569e44df72beed6f00a5b2c62cf1f50efb657b43764a5304e8860
 SHA512:
-  metadata.gz: 118befdc8fca693dd91610d8c0ecff86ca2e297cdb1b3817384b1fa78958a5949f1d252cc70eadf2187bee87080fb9949382e656b6765f259f4d23bba7fd2c47
-  data.tar.gz: 21f3339a6e874bca7d94fa3efcd92812afbbc0e9b74371cafc8eb3e1644334930671ee59841a13237998272acc06954916a5b09ccd9eb760df38c8b3a28557f9
+  metadata.gz: 27141bf2c3082bef253ef90f838fc272600ef87e9c6767bd93acf7f2007beaa97c9e995d0a7e563ee2595945eb38e1ff93fbe3a445d6cb0182cfdcbf7b092885
+  data.tar.gz: 91c5267b99ce330cd04c09843822085c8c3917fb718537d516d769be75f23c3a40618442037e55800f57d6139df95ec4e12a647c3e100d7d6244a9e9c84bd893

data/.rubocop.yml

@@ -1,84 +1,85 @@
-AllCops:
-  NewCops: enable
-  Exclude:
-    - 'spec/**/*'
-    - 'db/**/*'
-    - 'Gemfile'
-    - 'vendor/**/*' # or vendor/bundle/**/*
-
-Gemspec/OrderedDependencies:
-  Enabled: false # I like to group them, so what?
-
-Metrics/BlockLength:
-  Max: 30
-
-Metrics/MethodLength:
-  Max: 30
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/PerceivedComplexity:
-  Max: 12
-
-Metrics/CyclomaticComplexity:
-  Max: 12
-
-Layout/EndOfLine:
-  Enabled: false
-
-Layout/ExtraSpacing:
-  Enabled: false
-
-Layout/HashAlignment:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  # I like to space repeated grammars out tabulated, defund these cops
-  Enabled: false
-
-Layout/EmptyLinesAroundExceptionHandlingKeywords:
-  Enabled: false
-
-Layout/SpaceInsideBlockBraces:
-  Enabled: false
-
-Layout/SpaceInsideParens:
-  Enabled: false
-
-Layout/SpaceAroundOperators:
-  Enabled: false
-
-Lint/EmptyBlock:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/RaiseArgs:
-  Enabled: false
-
-Style/RedundantBegin:
-  Enabled: false
-
-Style/RescueModifier:
-  Enabled: false
-
-Style/OptionalBooleanParameter:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  # the cops change this preference every version of ruby, but who cares in the first place?
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Enabled: false
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - 'spec/**/*'
+    - 'db/**/*'
+    - 'Gemfile'
+    - 'vendor/**/*' # or vendor/bundle/**/*
+
+Gemspec/OrderedDependencies:
+  Enabled: false # I like to group them, so what?
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+Layout/EndOfLine:
+  Enabled: false
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  # I like to space repeated grammars out tabulated, defund these cops
+  Enabled: false
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  # the cops change this preference every version of ruby, but who cares in the first place?
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.3
+3.3.1

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+0.7.0 08/27/2025
+================
+
+Support for Ruby > 3, Rails 7.2+.
+
+0.6.0 07/21/2022
+================
+
+Support for Rails >6.
+
 0.5.7 03/10/2022
 ================
 

data/Gemfile

@@ -1,6 +1,11 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'devise'
+gem 'grape-entity'
+gem 'grape-swagger'
+gem 'validates_by_schema'
+
 # Declare your gem's dependencies in introspective_grape.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
@@ -11,8 +16,23 @@ gemspec
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
 
+
 group :development, :test do
+  # testing
+  gem 'brakeman'
+  gem 'bundler-audit'
   gem 'byebug'
-  gem 'rb-readline'
   gem 'coveralls_reborn', require: false
+  gem 'machinist_redux'
+  gem 'rb-readline'
+  gem 'rspec-rails', '>= 3.0'
+  gem 'rubocop'
+  gem 'simplecov'
+
+  # dummy app dependencies
+  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'devise'
+  gem 'kt-paperclip'
+  gem 'rufus-mnemo'
+  gem 'sqlite3', platforms: :ruby
 end

data/README.md

@@ -15,21 +15,18 @@
 
 IntrospectiveGrape is a rails plugin for DRYing up
 [Grape APIs](https://github.com/ruby-grape/grape) by laying out simple
-(or, if you like, very complex) RESTful defaults based on the introspection of your database by
-[SchemaPlusValidations](https://github.com/SchemaPlus/schema_validations).
+(or, if you like, very complex) RESTful defaults based on your database schema.
 
 IntrospectiveGrape provides handling for deeply nested relations according to the models'
 `accepts_nested_attributes_for` declarations, generating all the necessary
-boilerplate for flexible and consistent bulk endpoints on plural associations,
-and building nested routes for the same.
+boilerplate for flexible and consistent bulk endpoints on plural associations
+and building the deeply nested routes for acting upon individual records.
 
 It relies on [Kaminari](https://github.com/kaminari/kaminari) for pagination and [Pundit](https://github.com/varvet/pundit) for authorization, both of which are semi-optional.
 
-To facilitate idiomatic ruby and javascript, respectively, it also makes it easy to snakecase incoming parameters and camelize outputs, all the way through to your swagger docs.
-
-NOTE: SchemaPlus is not currently being maintained and is unavailable for Rails > 2.5, and thus so is
-IntrospectiveGrape. Which is too bad! I don't know how anybody with a relational database gets by
-without it. We're working on it when we get the chance.
+To facilitate idiomatic ruby and javascript, respectively, it makes it trivial to snakecase
+incoming parameters and camelize outputs, all the way through to your automatically generated
+swagger documentation.
 
 ## Documentation
 
@@ -54,11 +51,9 @@ class MyAPI < Grape::API
 end
 ```
 
-This also monkey patches Grape::Swagger to camelize your API's self-documentation, while snakecasing parameters passed to your API.
-
-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.
+This also monkey-patches Grape::Swagger to camelize your API's self-documentation, while snakecasing parameters passed to your API.
 
-If you need to disable all camel-snake transliteration set `IntrospectiveGrape.config.camelize_parameters = false` down in `config/initializers` and do not `require` or `formatter` those patches.
+If you prefer to disable all camel-snake transliterations set `IntrospectiveGrape.config.camelize_parameters = false` down in `config/initializers`.
 
 ## Authentication and authorization
 
@@ -70,7 +65,7 @@ IntrospectiveGrape::API.authentication_method = "whatever!"
 
 Pundit authorization is invoked against index?, show?, update?, create?, and destroy? methods with the model instance in question (or a new instance in the case of index).
 
-The joke goes that you may find you need to allow an unauthenticated user to attempt a log in, which can be handled with something like:
+The joke goes that you may find you need to allow an unauthenticated user to attempt a log in, which can be handled by authorizing non-users at that endpoint with something like:
 
 ```
   def authorize!
@@ -90,10 +85,10 @@ IntrospectiveGrape's parameterization of a model begins with the `restful` decla
 The simplest app/api/v1/my_model_api.rb with the broadest functionality would look like:
 
 ```
-class MyModelAPI < IntrospectiveGrape::API
+class MyModelApi < IntrospectiveGrape::API
   filter_on :all
 
-  restful MyModel, [:strong, :param, :fields, :and, { nested_model_attributes: [:nested,:fields, :_destroy] }]
+  restful MyModel, [:strong, :param, :fields, :and, { nested_model_attributes: [:nested, :fields, :_destroy] }]
 
   class <NestedModel>Entity < Grape::Entity
     expose :id, :attribute
@@ -109,9 +104,9 @@ end
 
 This would set up all the basic RESTFUL actions with nested routes for the associated model and its association, providing a good deal of flexibility for API consumers out of the box.
 
-IntrospectiveGrape looks in the MyModelAPI class for grape-entity definitions. If you prefer to define your entities elsewhere you could inherit them here instead.
+IntrospectiveGrape looks in the `MyModelApi` class for grape-entity definitions. If you prefer to define your entities elsewhere you can import them here instead.
 
-NOTE: Nested entities must be defined before their parents, inside-out, or you'll run into loading errors.
+NOTE: Nested entities defined in the mounted API classes must be defined before their parents, inside-out, or you'll run into load errors.
 
 ## Customizing End Points
 
@@ -146,8 +141,6 @@ class MyModelAPI < IntrospectiveGrape::API
 end
 ```
 
-Please note, again, that the nested Grape::Entity is declared before its parent.
-
 ## Skipping a Presence Validation for a Required Field
 
 If a model has, say, a procedurally generated default for a not-null field in the database
@@ -179,6 +172,8 @@ You can also eager load nested associations, if necessary:
   default_includes NestedModel, <associations for eager loading>
 ```
 
+My suggestion would be to ignore this feature and rely instead on [ArLazyPreload](https://github.com/DmitryTsepelev/ar_lazy_preload).
+
 ## Pagination
 
 The index action by default will not be paginated. Simply declaring `paginate` before the `restful` declaration will enable [Kaminari](https://github.com/amatsuda/kaminari) pagination on the index results using a default 25 results per page with an offset of 0. You can pass Kaminari's options to the paginate declaration, `per_page`, `max_per_page`, etc.

data/introspective_grape.gemspec

@@ -1,63 +1,41 @@
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-
-# Maintain your gem's version:
-require 'introspective_grape/version'
-
-# Describe your gem and declare its dependencies:
-Gem::Specification.new do |s|
-  s.name        = 'introspective_grape'
-  s.version     = IntrospectiveGrape::VERSION
-  s.authors     = ['Josh Buermann']
-  s.email       = ['buermann@gmail.com']
-  s.homepage    = 'https://github.com/buermann/introspective_grape'
-  s.summary     = 'Quickly configure Grape APIs around your database schema and models.'
-  s.description = <<-DESC
-    IntrospectiveGrape provides handling for deeply nested relations according to the models'
-    `accepts_nested_attributes_for` declarations, generating all the necessary
-  boilerplate for flexible and consistent bulk endpoints on plural associations,
-    and building nested routes for the same.
-  DESC
-  s.license     = 'MIT'
-
-  s.files         = `git ls-files`.split("\n").sort
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
-
-  s.required_ruby_version = '> 2.5'
-
-  s.add_runtime_dependency 'rails', '~> 5.2'
-  s.add_runtime_dependency 'schema_validations'
-  s.add_runtime_dependency 'rack'
-
-  s.add_runtime_dependency 'grape', '1.6.0'
-  s.add_runtime_dependency 'dry-types'
-  s.add_runtime_dependency 'grape-entity'
-  s.add_runtime_dependency 'grape-swagger'
-
-  s.add_runtime_dependency 'kaminari'
-  s.add_runtime_dependency 'grape-kaminari'
-
-  s.add_runtime_dependency 'pundit'
-
-  s.add_runtime_dependency 'camel_snake_keys', '>0.0.4'
-
-  if RUBY_PLATFORM == 'java'
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
-  else
-    s.add_development_dependency 'sqlite3'
-  end
-
-  # testing gems
-  s.add_development_dependency 'rspec-rails', '>= 3.0'
-  s.add_development_dependency 'coveralls_reborn'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'bundler-audit'
-  s.add_development_dependency 'brakeman'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'byebug'
-  s.add_development_dependency 'machinist_redux'
-
-  # dummy app dependencies
-  s.add_development_dependency 'kt-paperclip'
-  s.add_development_dependency 'rufus-mnemo'
-  s.add_development_dependency 'devise'
-end
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+# Maintain your gem's version:
+require 'introspective_grape/version'
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'introspective_grape'
+  s.version     = IntrospectiveGrape::VERSION
+  s.authors     = ['Josh Buermann']
+  s.email       = ['buermann@gmail.com']
+  s.homepage    = 'https://github.com/buermann/introspective_grape'
+  s.summary     = 'Quickly configure Grape APIs around your database schema and models.'
+  s.description = <<-DESC
+    IntrospectiveGrape provides handling for deeply nested relations according to the models'
+    `accepts_nested_attributes_for` declarations, generating all the necessary
+    boilerplate for flexible and consistent bulk endpoints on plural associations,
+    and building nested routes for the same.
+  DESC
+  s.license     = 'MIT'
+  s.metadata    = { 'rubygems_mfa_required' => 'true' }
+
+  s.files         = `git ls-files`.split("\n").sort
+
+  s.required_ruby_version = '>= 3.1'
+
+  s.add_dependency 'rails' # , '6.1' #, '> 5.2'
+  s.add_dependency 'rack'
+
+  s.add_dependency 'grape' # , '1.6.0'
+  s.add_dependency 'dry-types'
+  s.add_dependency 'grape-entity'
+  s.add_dependency 'grape-swagger'
+
+  s.add_dependency 'kaminari'
+  s.add_dependency 'grape-kaminari'
+
+  s.add_dependency 'pundit'
+
+  s.add_dependency 'camel_snake_keys'
+end

data/lib/introspective_grape/api.rb

@@ -1,6 +1,6 @@
 require 'action_controller'
 require 'kaminari'
-#require 'byebug'
+# require 'byebug'
 require 'grape-kaminari'
 require 'introspective_grape/validators'
 
@@ -57,7 +57,7 @@ module IntrospectiveGrape
       PG2RUBY = { datetime: DateTime }.freeze
 
       def inherited(child)
-        super(child)
+        super
         child.before do
           # Ensure that a user is logged in.
           send(IntrospectiveGrape::API.authentication_method(self))
@@ -85,12 +85,17 @@ module IntrospectiveGrape
         #
 
         # Defining the api will break pending migrations during db:migrate, so bail:
-        begin ActiveRecord::Migration.check_pending! rescue return end
+        begin
+          ActiveRecord::Migration.check_all_pending!
+        rescue StandardError => e
+          warn "Migrations are pending: #{e.message}"
+          return
+        end
 
         # normalize the whitelist to symbols
         strong_params.map! {|f| f.is_a?(String) ? f.to_sym : f }
         # default to a flat representation of the model's attributes if left unspecified
-        strong_params = strong_params.blank? ? model.attribute_names.map(&:to_sym) - %i(id updated_at created_at) : strong_params
+        strong_params = model.attribute_names.map(&:to_sym) - %i(id updated_at created_at) if strong_params.blank?
 
         # The strong params will be the same for all routes, differing from the Grape params
         # when routes are nested
@@ -199,7 +204,7 @@ module IntrospectiveGrape
         dsl.put ":#{routes.last.swagger_key}" do
           authorize @model, :update?
 
-          @model.update_attributes!( safe_params(params).permit(klass.whitelist) )
+          @model.update!( safe_params(params).permit(klass.whitelist) )
 
           if IntrospectiveGrape.config.skip_object_reload
             present klass.find_leaf(routes, @model, params), with: "#{klass}::#{model}Entity".constantize
@@ -210,7 +215,6 @@ module IntrospectiveGrape
         end
       end
 
-      # rubocop:enable Metrics/AbcSize
       def define_destroy(dsl, routes, model, _api_params)
         klass = routes.first.klass
         name  = routes.last.name.singularize
@@ -225,6 +229,7 @@ module IntrospectiveGrape
           present status: (klass.find_leaf(routes, @model, params).destroy ? true : false)
         end
       end
+      # rubocop:enable Metrics/AbcSize
 
       def convert_nested_params_hash(dsl, routes)
         root  = routes.first
@@ -245,7 +250,7 @@ module IntrospectiveGrape
 
       def merge_nested_params(routes, params)
         attr = params.reject {|k| [routes.first.key, :api_key].include?(k) }
-        build_nested_attributes(routes[1..-1], attr)
+        build_nested_attributes(routes[1..], attr)
       end
 
       def define_restful_api(dsl, routes, model, api_params)
@@ -291,14 +296,19 @@ module IntrospectiveGrape
         reflection  = parent_model&.reflections&.fetch(reflection_name)
         swagger_key = IntrospectiveGrape.config.camelize_parameters ? "#{name.singularize.camelize(:lower)}Id" : "#{name.singularize}_id"
 
-        routes.push OpenStruct.new(klass: self, name: name, param: "#{name}_attributes", model: model,
-                                   many?: plural?(parent_model, reflection),
-                                   key: "#{name.singularize}_id".to_sym,
-                                   swagger_key: swagger_key, reflection: reflection)
+        routes.push Route.new(
+          klass: self,
+          name: name,
+          param: "#{name}_attributes",
+          model: model,
+          many: plural?(parent_model, reflection),
+          key: :"#{name.singularize}_id",
+          swagger_key: swagger_key, reflection: reflection
+        )
       end
 
       def plural?(model, reflection)
-        (model && PLURAL_REFLECTIONS.include?(reflection.class))
+        model && PLURAL_REFLECTIONS.include?(reflection.class)
       end
 
       def build_nested_attributes(routes, hash)

data/lib/introspective_grape/camel_snake.rb

@@ -11,7 +11,7 @@ if IntrospectiveGrape.config.camelize_parameters
         parsed_params.each do |param|
           param[:name] = param[:name]
                          .camelize(:lower)
-                         .gsub(/Destroy/, '_destroy')
+                         .gsub('Destroy', '_destroy')
         end
         super(params, path, method, _options = {})
       end
@@ -34,8 +34,8 @@ if IntrospectiveGrape.config.camelize_parameters
   else
     module CallWithCamelized
       def call(*args)
-        param = super(*args)
-        param[:name] = param[:name].camelize(:lower).gsub(/Destroy/, '_destroy')
+        param = super
+        param[:name] = param[:name].camelize(:lower).gsub('Destroy', '_destroy')
         param
       end
     end

data/lib/introspective_grape/create_helpers.rb

@@ -4,7 +4,7 @@ module IntrospectiveGrape
       dsl.send(:authorize, model, :create?)
       ActiveRecord::Base.transaction do
         old = find_leaves(routes, model, params)
-        model.update_attributes( dsl.send(:safe_params, params).permit(whitelist) )
+        model.update( dsl.send(:safe_params, params).permit(whitelist) )
         new = find_leaves(routes, model, params)
         old.respond_to?(:size) ? new - old : new
       end

data/lib/introspective_grape/filters.rb

@@ -62,7 +62,7 @@ module IntrospectiveGrape
       if timestamp_filter(klass, model, field)
         dsl.optional field, type: klass.param_type(model, field), description: "Constrain #{field} by #{humanize_date_range(field)} date."
       elsif identifier_filter?(model, field)
-        dsl.optional field, type: Array[String], coerce_with: ->(val) { val.split(',') }, description: 'Filter by a comma separated list of unique identifiers.'
+        dsl.optional field, type: [String], coerce_with: ->(val) { val.split(',') }, description: 'Filter by a comma separated list of unique identifiers.'
       else
         dsl.optional field, type: klass.param_type(model, field), description: "Filter on #{field} by value."
       end
@@ -82,7 +82,9 @@ module IntrospectiveGrape
 
     def filter_doc
       <<-STR
-        JSON of conditions for query.  If you're familiar with ActiveRecord's query conventions you can build more complex filters, i.e. against included child associations, e.g.: {\"&lt;association_name&gt;_&lt;parent&gt;\":{\"field\":\"value\"}}
+  JSON of conditions for query.
+
+  If you're familiar with ActiveRecord's query conventions you can build more complex filters, i.e. against included child associations, e.g.: {"&lt;association_name&gt;_&lt;parent&gt;":{"field":"value"}}
       STR
     end
 
@@ -106,7 +108,7 @@ module IntrospectiveGrape
         records = apply_simple_filter(klass, model, params, records, field)
       end
 
-      klass.custom_filters.each do |filter, _details|
+      klass.custom_filters.each_key do |filter|
         records = records.send(filter, params[filter])
       end
 

data/lib/introspective_grape/route.rb

@@ -0,0 +1,11 @@
+class Route
+  attr_accessor(*%i[klass name param model many key swagger_key reflection])
+
+  def initialize(attrs = {})
+    attrs.each { |key, value| instance_variable_set("@#{key}", value) }
+  end
+
+  def many?
+    many ? true : false
+  end
+end