introspective_grape 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2a07edad73a2ac601dfb2743775e01047ad725471d30694f3dec9579a0f0450
-  data.tar.gz: 6db4149759fe421ccc157124f2c4f5b5edc757b79646efff20ab6726f7f378f0
+  metadata.gz: 6ec4b919395ffd2b409a4a4b93f223aa10406fef2886f33cc5b8d9ec89e3822b
+  data.tar.gz: 7269f346109569e44df72beed6f00a5b2c62cf1f50efb657b43764a5304e8860
 SHA512:
-  metadata.gz: bebc8fc3eb3e95e6c26a4b751485c666cd79cf485d8604d011bdcbfcc210c8d7a9411a976d28be5a012504d1a34dce68a872c33149ec76066ac57eddcff00e39
-  data.tar.gz: 1ae975dfdcbb9992981809c2ada02a5d04ab1453be6c136bcd523711b9e362fbee7e3e1cad726f5e12a92c38e5e44e2d003f6db0706be127ad6c9c9ec6ba79f2
+  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,22 +1,38 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'devise'
-gem 'grape-entity'
-gem 'grape-swagger'
-
-# 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.
-
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-group :development, :test do
-  gem 'byebug'
-  gem 'rb-readline'
-  gem 'coveralls_reborn', require: false
-end
+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.
+
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# 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 '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

data/introspective_grape.gemspec

@@ -1,64 +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.metadata    = { "rubygems_mfa_required" => "true" }
-
-  s.files         = `git ls-files`.split("\n").sort
-
-  s.required_ruby_version = '> 2.5' # rubocop:disable Gemspec/RequiredRubyVersion
-
-  s.add_runtime_dependency 'rails' # , '6.1' #, '> 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'
-  s.metadata['rubygems_mfa_required'] = 'true'
-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