grape-entity 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0080bab47d3cd3667c29ef580dcca4977ba5572d95c56304dd55cc444456fc
-  data.tar.gz: 40b564ee118de1a2a5b36dcff7526ca6bb1c54d738b7ac2191b1a208a583add1
+  metadata.gz: 4a89222a95fe66dc86d907762352275aa328a0423a461e2f5a7c8fc806a92f09
+  data.tar.gz: a06ad75430e568a7e4cd2e9b6b329011e8382003c5882f690199403be58928c7
 SHA512:
-  metadata.gz: 06564de07c6a909a3dbd4c3839902f529c5c44291f1a0669bcbc3dca7ea1e015db71887ca9f46132ef5bf4bb01fd10fced74b09ac392f3678903d39875816b63
-  data.tar.gz: 3e22b1382012b543d50a256e1792f9f79e3b02d49e42420353a351d49f549f021cd3dede90c576f657f0e61df862c0d8879cfb9c0a1d4578ef77a5648845ff6e
+  metadata.gz: 1bc3419fea51eb0c7c7c78f8f4e510c9d73bfe210cee2aa1f2aaaee92725d02334ab235818a37300c733c0970c9ee40cf56a022b421937ec6662d3e67da3e85f
+  data.tar.gz: 4f31cb8e01fbba21883bbf432fa557d0ca7f85d3c1d42a0aac0e4143c4add3af37e7f24b4fc315ff55502a640bffa0d185e8c3081d8a8b5492d45dc1b0102233

data/.github/dependabot.yml

@@ -12,3 +12,9 @@ updates:
       day: "friday"
     assignees:
       - "LeFnord"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
+    assignees:
+     - "LeFnord"

data/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+permissions:
+  contents: read
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel --format progress
+
+  rspec:
+    runs-on: ubuntu-latest
+    needs: ['rubocop']
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', 'head', jruby, truffleruby]
+    steps:
+    - name: Check out branch
+      uses: actions/checkout@v3
+    - 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/.rspec

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

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - vendor/**/*
     - example/**/*
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.1
   SuggestExtensions: false
 
 #  Layout stuff
@@ -77,6 +77,9 @@ Naming:
 Style/Documentation:
   Enabled: false
 
+Style/HashSyntax:
+  Enabled: false
+
 Style/OptionalBooleanParameter:
   AllowedMethods:
     # from lib/grape_entity/condition/base.rb

data/.rubocop_todo.yml

@@ -1,11 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-11-07 00:01:40 UTC using RuboCop version 1.2.0.
+# 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
@@ -14,14 +30,20 @@ Gemspec/RequiredRubyVersion:
     - 'grape-entity.gemspec'
 
 # Offense count: 6
-# Cop supports --auto-correct.
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Lint/BooleanSymbol:
   Exclude:
     - 'spec/grape_entity/exposure_spec.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: IgnoredMethods.
+# 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:

data/CHANGELOG.md

@@ -9,6 +9,22 @@
 * Your contribution here.
 
 
+### 0.10.2 (2022-07-29)
+
+#### 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).
+* [#361](https://github.com/ruby-grape/grape-entity/pull/361): Require 'active_support/core_ext' - [@pravi](https://github.com/pravi).
+
+
+### 0.10.1 (2021-10-22)
+
+#### Fixes
+
+* [#359](https://github.com/ruby-grape/grape-entity/pull/359): Respect `hash_access` setting when using `expose_nil: false` option - [@magni-](https://github.com/magni-).
+
+
 ### 0.10.0 (2021-09-15)
 
 #### Features

data/CONTRIBUTING.md

@@ -78,7 +78,7 @@ git push origin my-feature-branch
 
 #### Make a Pull Request
 
-Go to https://github.com/contributor/grape-entity and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+Go to https://github.com/ruby-grape/grape-entity and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
 #### Rebase
 

data/README.md

@@ -111,6 +111,20 @@ The field lookup takes several steps
 * next try `object.fetch(exposure)`
 * last raise an Exception
 
+`exposure` is a Symbol by default. If `object` is a Hash with stringified keys, you can set the hash accessor at the entity-class level to properly expose its members:
+
+```ruby
+class Status < GrapeEntity
+  self.hash_access = :to_s
+
+  expose :code
+  expose :message
+end
+
+Status.represent({ 'code' => 418, 'message' => "I'm a teapot" }).as_json
+#=> { code: 418, message: "I'm a teapot" }
+```
+
 #### Exposing with a Presenter
 
 Don't derive your model classes from `Grape::Entity`, expose them using a presenter.

data/lib/grape_entity/delegator/base.rb

@@ -13,6 +13,11 @@ module Grape
         def delegatable?(_attribute)
           true
         end
+
+        def accepts_options?
+          # Why not `arity > 1`? It might be negative https://ruby-doc.org/core-2.6.6/Method.html#method-i-arity
+          method(:delegate).arity != 1
+        end
       end
     end
   end

data/lib/grape_entity/delegator.rb

@@ -11,10 +11,14 @@ module Grape
     module Delegator
       def self.new(object)
         delegator_klass =
-          if object.is_a?(Hash) then HashObject
-          elsif defined?(OpenStruct) && object.is_a?(OpenStruct) then OpenStructObject
-          elsif object.respond_to?(:fetch, true) then FetchableObject
-          else PlainObject
+          if object.is_a?(Hash)
+            HashObject
+          elsif defined?(OpenStruct) && object.is_a?(OpenStruct)
+            OpenStructObject
+          elsif object.respond_to?(:fetch, true)
+            FetchableObject
+          else
+            PlainObject
           end
 
         delegator_klass.new(object)

data/lib/grape_entity/entity.rb

@@ -481,9 +481,6 @@ module Grape
       @object = object
       @options = options.is_a?(Options) ? options : Options.new(options)
       @delegator = Delegator.new(object)
-
-      # Why not `arity > 1`? It might be negative https://ruby-doc.org/core-2.6.6/Method.html#method-i-arity
-      @delegator_accepts_opts = @delegator.method(:delegate).arity != 1
     end
 
     def root_exposures
@@ -525,7 +522,10 @@ module Grape
       end
     rescue StandardError => e
       # it handles: https://github.com/ruby/ruby/blob/v3_0_0_preview1/NEWS.md#language-changes point 3, Proc
-      raise Grape::Entity::Deprecated.new e.message, 'in ruby 3.0' if e.is_a?(ArgumentError)
+      # 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
 
       raise e
     end
@@ -541,7 +541,7 @@ module Grape
     def delegate_attribute(attribute)
       if is_defined_in_entity?(attribute)
         send(attribute)
-      elsif @delegator_accepts_opts
+      elsif delegator.accepts_options?
         delegator.delegate(attribute, **self.class.delegation_opts)
       else
         delegator.delegate(attribute)

data/lib/grape_entity/exposure/base.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_support'
+require 'active_support/core_ext'
+
 module Grape
   class Entity
     module Exposure

data/lib/grape_entity/exposure.rb

@@ -56,7 +56,12 @@ module Grape
           Condition.new_unless(
             proc do |object, _options|
               if options[:proc].nil?
-                Delegator.new(object).delegate(attribute).nil?
+                delegator = Delegator.new(object)
+                if is_a?(Grape::Entity) && delegator.accepts_options?
+                  delegator.delegate(attribute, **self.class.delegation_opts).nil?
+                else
+                  delegator.delegate(attribute).nil?
+                end
               else
                 exec_with_object(options, &options[:proc]).nil?
               end

data/lib/grape_entity/options.rb

@@ -9,7 +9,7 @@ module Grape
 
       attr_reader :opts_hash
 
-      def_delegators :opts_hash, :dig, :key?, :fetch, :[], :empty
+      def_delegators :opts_hash, :dig, :key?, :fetch, :[], :empty?
 
       def initialize(opts_hash = {})
         @opts_hash = opts_hash

data/lib/grape_entity/version.rb

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

data/spec/grape_entity/entity_spec.rb

@@ -389,6 +389,10 @@ describe Grape::Entity do
             def method_without_args
               'result'
             end
+
+            def raises_argument_error
+              raise ArgumentError, 'something different'
+            end
           end
 
           describe 'with block passed in' do
@@ -402,6 +406,17 @@ describe Grape::Entity do
               value = subject.represent(object).value_for(:that_method_without_args)
               expect(value).to eq('result')
             end
+
+            it 'does not suppress ArgumentError' do
+              subject.expose :raises_argument_error do |object|
+                object.raises_argument_error
+              end
+
+              object = SomeObject.new
+              expect do
+                subject.represent(object).value_for(:raises_argument_error)
+              end.to raise_error(ArgumentError, 'something different')
+            end
           end
 
           context 'with block passed in via &' do

data/spec/grape_entity/hash_spec.rb

@@ -17,7 +17,7 @@ describe Grape::Entity do
         expose :post, if: :full
         expose :city
         expose :street
-        expose :house
+        expose :house, expose_nil: false
       end
 
       class Company < Grape::Entity
@@ -62,9 +62,23 @@ describe Grape::Entity do
       }
     }
 
+    company_without_house_with_string = {
+      'full_name' => 'full_name',
+      'name' => 'name',
+      'address' => {
+        'post' => '123456',
+        'city' => 'city',
+        'street' => 'street',
+        'something_else' => 'something_else'
+      }
+    }
+
     expect(EntitySpec::CompanyWithString.represent(company_with_string).serializable_hash).to eq \
       company.slice(:name).merge(address: company[:address].slice(:city, :street, :house))
 
+    expect(EntitySpec::CompanyWithString.represent(company_without_house_with_string).serializable_hash).to eq \
+      company.slice(:name).merge(address: company[:address].slice(:city, :street))
+
     expect(EntitySpec::CompanyWithString.represent(company_with_string, full: true).serializable_hash).to eq \
       company.slice(:full_name, :name).merge(address: company[:address].slice(:city, :street, :house))
 

data/spec/spec_helper.rb

@@ -9,12 +9,16 @@ require 'active_support/core_ext/hash' if ActiveSupport::VERSION &&
                                           ActiveSupport::VERSION::MAJOR &&
                                           ActiveSupport::VERSION::MAJOR < 4
 
-SimpleCov.start do
-  add_filter 'spec/'
+# Skip code covarge on Ruby >= 3.1
+# See https://github.com/simplecov-ruby/simplecov/issues/1003
+unless RUBY_VERSION >= '3.1'
+  SimpleCov.start do
+    add_filter 'spec/'
+  end
+
+  Coveralls.wear! unless RUBY_PLATFORM.eql? 'java'
 end
 
-Coveralls.wear! unless RUBY_PLATFORM.eql? 'java'
-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.2
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -160,8 +160,7 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".github/dependabot.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -232,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.

data/.github/workflows/rubocop.yml

@@ -1,26 +0,0 @@
-name: Rubocop
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  rubocop:
-    name: Rubocop
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: '3.0'
-      - run: gem install rubocop --no-doc
-      - run: rubocop --format progress --format json --out rubocop.json
-        id: rubocop
-      - uses: duderman/rubocop-annotate-action@v0.1.0
-        with:
-          path: rubocop.json
-        if: ${{ failure() }}

data/.github/workflows/ruby.yml

@@ -1,26 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - '*'
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  spec:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0', head, jruby, truffleruby]
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run rspec
-      run: bundle exec rspec