grape-entity 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f0e5dbd15616782e392614348386ade34ec6c0a2ab27c75603fc654adf068e
-  data.tar.gz: d412d26ef311e83c489aacbc84d6e8f7caabcae3c0d43dc22120d135d184aa00
+  metadata.gz: a112c98cc0eb8353a9185c5276133d05ad196a076f6184a7a624787e4c050d36
+  data.tar.gz: 68ea3662d7df4e23d41812ae5e3e143bf81e8ccab3ee27357cfa4b25875f897a
 SHA512:
-  metadata.gz: fd34cb1b90bb0353ea4097cab79027cb77cdb9c44dd2ad3fa73595d01e29395e94233165ad6d049380e0200aef3bec792ea5f22ecb3bb94ecf4e72e9a22fcc45
-  data.tar.gz: afa32b651692da1cc7dc604181360166f3799ae66b17901d93c5ba90b17f98b5d038ec2c4cd08f62a83e5d548c9cce18f5664518c2170f4dc31307d48339146e
+  metadata.gz: a481cda35933c22d6a85a6e6fa1b5eebc61914b69f0ae1f97b409767911dc1ad81df6c706a4cc4c23c293e85401b735c49c7498ef40965f4ef6b3da5022596bb
+  data.tar.gz: 9f7595af9724f9ec4a41dbbc4a6099f8b87fbc19e87d2c0632dad686940cacc04acd9038e856de0376d06f402812b235ede732dde550bd753be9eee8669f1fd8

data/CHANGELOG.md

@@ -1,27 +1,37 @@
 ### Next
 
-#### Features
+### 1.0.3 (2026-04-15)
 
-* Your contribution here.
+* [#400](https://github.com/ruby-grape/grape-entity/pull/400): Switch to danger-pr-comment for PR checks - [@numbata](https://github.com/numbata).
+* [#397](https://github.com/ruby-grape/grape-entity/pull/397): Reduce gem size by excluding test files - [@yuri-zubov](https://github.com/yuri-zubov).
+* [#401](https://github.com/ruby-grape/grape-entity/pull/401): Modernize gemspec: add metadata, use Dir glob, require MFA - [@numbata](https://github.com/numbata).
 
 #### Fixes
 
-* Your contribution here.
+* [#399](https://github.com/ruby-grape/grape-entity/pull/399): Fix `ArgumentError` for single-argument lambdas in `expose` blocks and `if:` conditions - [@numbata](https://github.com/numbata).
+
+### 1.0.2 (2026-04-13)
+
+#### Fixes
 
+* [#394](https://github.com/ruby-grape/grape-entity/pull/394): Add `Entity.[]` for Grape >= 3.2 param type compatibility - [@numbata](https://github.com/numbata).
+* [#388](https://github.com/ruby-grape/grape-entity/pull/388): Drop ruby-head from test matrix - [@numbata](https://github.com/numbata).
+* [#389](https://github.com/ruby-grape/grape-entity/pull/389): Block arity detection (breaking change) - [@numbata](https://github.com/numbata).
+* [#385](https://github.com/ruby-grape/grape-entity/pull/385): Drop multijson dependency - [@ericproulx](https://github.com/ericproulx).
+* [#384](https://github.com/ruby-grape/grape-entity/pull/384): Fix `inspect` to correctly handle `nil` values - [@fcce](https://github.com/fcce).
 
-### ### 1.0.1 (2024-04-10)
+### 1.0.1 (2024-04-10)
 
 #### Fixes
 
 * [#381](https://github.com/ruby-grape/grape-entity/pull/381): Fix `expose_nil: false` when using a block - [@magni-](https://github.com/magni-).
 
 
-### ### 1.0.0 (2023-02-16)
+### 1.0.0 (2023-02-16)
 
 #### Fixes
 
-**Breaking change:**
-* [#352](https://github.com/ruby-grape/grape-entity/pull/369): Remove `FetchableObject` behavior. - [@danielvdao](https://github.com/danielvdao).
+* [#369](https://github.com/ruby-grape/grape-entity/pull/369): Remove `FetchableObject` behavior (breaking change) - [@danielvdao](https://github.com/danielvdao).
 * [#371](https://github.com/ruby-grape/grape-entity/pull/371): Allow default exposed value to be `false` or any empty data - [@norydev](https://github.com/norydev).
 
 
@@ -29,8 +39,8 @@
 
 #### Fixes
 
-* [#366](https://github.com/ruby-grape/grape-entity/pull/366): Don't suppress regular ArgumentError exceptions - [splattael](https://github.com/splattael).
-* [#363](https://github.com/ruby-grape/grape-entity/pull/338): Fix typo - [@OuYangJinTing](https://github.com/OuYangJinTing).
+* [#366](https://github.com/ruby-grape/grape-entity/pull/366): Don't suppress regular ArgumentError exceptions - [@splattael](https://github.com/splattael).
+* [#363](https://github.com/ruby-grape/grape-entity/pull/363): Fix typo - [@OuYangJinTing](https://github.com/OuYangJinTing).
 * [#361](https://github.com/ruby-grape/grape-entity/pull/361): Require 'active_support/core_ext' - [@pravi](https://github.com/pravi).
 
 

data/README.md

@@ -33,6 +33,7 @@
     - [Using Entities](#using-entities)
     - [Entity Organization](#entity-organization)
     - [Caveats](#caveats)
+    - [Preloading Associations](#preloading-associations)
   - [Installation](#installation)
   - [Testing with Entities](#testing-with-entities)
   - [Project Resources](#project-resources)
@@ -674,6 +675,10 @@ end
 
 Also note that an `ArgumentError` is raised when unknown options are passed to either `expose` or `with_options`.
 
+### Preloading Associations
+
+Use [Grape::Entity::Preloader](https://github.com/OuYangJinTing/grape-entity-preloader) to preload associations and callbacks and avoid N+1 operations.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/grape_entity/entity.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'multi_json'
+require 'grape_entity/json'
 
 module Grape
   # An Entity is a lightweight structure that allows you to easily
@@ -129,6 +129,12 @@ module Grape
       def delegation_opts
         @delegation_opts ||= { hash_access: hash_access }
       end
+
+      # Satisfies the respond_to?(:[]) check in Grape::DryTypes (>= 3.2)
+      # so Entity subclasses can be used as param types.
+      def [](val)
+        val
+      end
     end
 
     @formatters = {}
@@ -472,8 +478,13 @@ module Grape
 
     # Prevent default serialization of :options or :delegator.
     def inspect
-      fields = serializable_hash.map { |k, v| "#{k}=#{v}" }
-      "#<#{self.class.name}:#{object_id} #{fields.join(' ')}>"
+      object = serializable_hash
+      if object.nil?
+        "#<#{self.class.name}:#{object_id} nil>"
+      else
+        fields = object.map { |k, v| "#{k}=#{v}" }
+        "#<#{self.class.name}:#{object_id} #{fields.join(' ')}>"
+      end
     end
 
     def initialize(object, options = {})
@@ -514,19 +525,44 @@ module Grape
     end
 
     def exec_with_object(options, &block)
-      if block.parameters.count == 1
+      if symbol_to_proc_wrapper?(block)
+        ensure_block_arity!(block)
+        instance_exec(object, &block)
+      elsif block.arity == 1
         instance_exec(object, &block)
       else
         instance_exec(object, options, &block)
       end
-    rescue StandardError => e
-      # it handles: https://github.com/ruby/ruby/blob/v3_0_0_preview1/NEWS.md#language-changes point 3, Proc
-      # accounting for expose :foo, &:bar
-      if e.is_a?(ArgumentError) && block.parameters == [[:req], [:rest]]
-        raise Grape::Entity::Deprecated.new e.message, 'in ruby 3.0'
+    end
+
+    def ensure_block_arity!(block)
+      # MRI currently always includes "( &:foo )" for symbol-to-proc wrappers.
+      # If this format changes in a new Ruby version, this logic must be updated.
+      origin_method_name = block.to_s.scan(/(?<=\(&:)[^)]+(?=\))/).first&.to_sym
+      return unless origin_method_name
+
+      unless object.respond_to?(origin_method_name, true)
+        raise ArgumentError, <<~MSG
+          Cannot use `&:#{origin_method_name}` because that method is not defined in the object.
+        MSG
       end
 
-      raise e
+      arity = object.method(origin_method_name).arity
+      return if arity.zero?
+
+      raise ArgumentError, <<~MSG
+        Cannot use `&:#{origin_method_name}` because that method expects #{arity} argument#{'s' if arity != 1}.
+        Symbol‐to‐proc shorthand only works for zero‐argument methods.
+      MSG
+    end
+
+    def symbol_to_proc_wrapper?(block)
+      params = block.parameters
+
+      return false unless block.lambda? && block.source_location.nil?
+      return false unless params.size >= 2
+
+      params[0].first == :req && params[1].first == :rest
     end
 
     def exec_with_attribute(attribute, &block)
@@ -558,7 +594,7 @@ module Grape
 
     def to_json(options = {})
       options = options.to_h if options&.respond_to?(:to_h)
-      MultiJson.dump(serializable_hash(options))
+      Grape::Entity::Json.dump(serializable_hash(options))
     end
 
     def to_xml(options = {})

data/lib/grape_entity/json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    if defined?(::MultiJson)
+      Json = ::MultiJson
+    else
+      Json = ::JSON
+      Json::ParseError = Json::ParserError
+    end
+  end
+end

data/lib/grape_entity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeEntity
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2026-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,20 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.2
 description: Extracted from Grape, A Ruby framework for rapid API development with
   great conventions.
 email:
@@ -48,26 +34,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Dangerfile
-- Gemfile
-- Guardfile
 - LICENSE
 - README.md
-- RELEASING.md
-- Rakefile
-- UPGRADING.md
-- bench/serializing.rb
-- grape-entity.gemspec
 - lib/grape-entity.rb
 - lib/grape_entity.rb
 - lib/grape_entity/condition.rb
@@ -92,19 +61,19 @@ files:
 - lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb
 - lib/grape_entity/exposure/nesting_exposure/output_builder.rb
 - lib/grape_entity/exposure/represent_exposure.rb
+- lib/grape_entity/json.rb
 - lib/grape_entity/options.rb
 - lib/grape_entity/version.rb
-- spec/grape_entity/entity_spec.rb
-- spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb
-- spec/grape_entity/exposure/represent_exposure_spec.rb
-- spec/grape_entity/exposure_spec.rb
-- spec/grape_entity/hash_spec.rb
-- spec/grape_entity/options_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/ruby-grape/grape-entity
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/ruby-grape/grape-entity
+  bug_tracker_uri: https://github.com/ruby-grape/grape-entity/issues
+  changelog_uri: https://github.com/ruby-grape/grape-entity/blob/v1.0.3/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape-entity/1.0.3
+  source_code_uri: https://github.com/ruby-grape/grape-entity/tree/v1.0.3
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -120,15 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
-test_files:
-- spec/grape_entity/entity_spec.rb
-- spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb
-- spec/grape_entity/exposure/represent_exposure_spec.rb
-- spec/grape_entity/exposure_spec.rb
-- spec/grape_entity/hash_spec.rb
-- spec/grape_entity/options_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.github/dependabot.yml

@@ -1,20 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "bundler" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-      day: "friday"
-    assignees:
-      - "LeFnord"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: weekly
-    assignees:
-     - "LeFnord"

data/.github/workflows/ci.yml

@@ -1,41 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-permissions:
-  contents: read
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
-          bundler-cache: true
-      - name: Run rubocop
-        run: bundle exec rubocop --parallel --format progress
-
-  rspec:
-    runs-on: ubuntu-latest
-    needs: ['rubocop']
-    strategy:
-      matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3', 'head']
-    steps:
-    - name: Check out branch
-      uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run rspec rest of the suite
-      run: bundle exec rspec

data/.gitignore

@@ -1,43 +0,0 @@
-## MAC OS
-.DS_Store
-.com.apple.timemachine.supported
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## REDCAR
-.redcar
-
-## VIM
-*.swp
-*.swo
-
-## RUBYMINE
-.idea
-
-## PROJECT::GENERAL
-coverage
-doc
-pkg
-.rvmrc
-.bundle
-.yardoc/*
-dist
-Gemfile.lock
-tmp
-coverage/
-.byebug_history
-.ruby-version
-.ruby-gemset
-
-## Rubinius
-.rbx
-
-## PROJECT::SPECIFIC
-.project

data/.rspec

@@ -1,3 +0,0 @@
---color
---profile
---format documentation

data/.rubocop.yml

@@ -1,89 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  Exclude:
-    - vendor/**/*
-    - example/**/*
-  NewCops: enable
-  TargetRubyVersion: 3.0
-  SuggestExtensions: false
-
-#  Layout stuff
-#
-Layout/EmptyLinesAroundArguments:
-  Enabled: false
-
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-
-#  Lint stuff
-#
-Lint/ConstantDefinitionInBlock:
-  Enabled: true
-  Exclude:
-    - spec/**/*
-
-#  Metrics stuff
-#
-Metrics/AbcSize:
-  Max: 25
-  AllowedMethods:
-    # from lib/grape_entity/exposure/nesting_exposure.rb
-    - 'normalized_exposures'
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Metrics/CyclomaticComplexity:
-  Max: 13
-
-Metrics/ClassLength:
-  Max: 300
-
-Metrics/MethodLength:
-  Max: 26
-  Exclude:
-    - spec/**/*
-
-Metrics/PerceivedComplexity:
-  Max: 11
-  AllowedMethods:
-    # from lib/grape_entity/entity.rb
-    - 'expose'
-    - 'merge_options'
-    # from lib/grape_entity/exposure/nesting_exposure.rb
-    - 'normalized_exposures'
-
-#  Naming stuff
-#
-
-Naming:
-  Enabled: false
-
-#  Style stuff
-#
-Style/Documentation:
-  Enabled: false
-
-Style/HashSyntax:
-  Enabled: false
-
-Style/OptionalBooleanParameter:
-  AllowedMethods:
-    # from lib/grape_entity/condition/base.rb
-    - 'initialize'
-    # form lib/grape_entity/entity.rb
-    - 'entity_class'
-    - 'present_collection'

data/.rubocop_todo.yml

@@ -1,50 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-07-26 21:29:59 UTC using RuboCop version 1.32.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/DeprecatedAttributeAssignment:
-  Exclude:
-    - 'grape-entity.gemspec'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'grape-entity.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'grape-entity.gemspec'
-
-# Offense count: 6
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Lint/BooleanSymbol:
-  Exclude:
-    - 'spec/grape_entity/exposure_spec.rb'
-
-# Offense count: 15
-Style/OpenStructUse:
-  Exclude:
-    - 'lib/grape_entity/delegator.rb'
-    - 'spec/grape_entity/entity_spec.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowMethodsWithArguments, IgnoredMethods, AllowComments.
-# IgnoredMethods: respond_to, define_method
-Style/SymbolProc:
-  Exclude:
-    - 'spec/grape_entity/entity_spec.rb'

data/.yardopts

@@ -1,2 +0,0 @@
---markup-provider=redcarpet
---markup=markdown