grape-entity 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb3365afa36454c797c3d44adfa51ecc757a105fe6cb6644f3f3896ff06af48d
-  data.tar.gz: 1e3c91d73fb17727c931443910b2f602e037384eb4f04e055207bbaf471c3962
+  metadata.gz: aa38cbc30d489d88e91c10c688c581251392a448330eca12ff79ebe22958bd9c
+  data.tar.gz: a96f1d0ada161d659f71aaca4e44588afc2727f4966e3f46058189483d46aa0c
 SHA512:
-  metadata.gz: ba4bd4207a7c5f5f09806017b29723ba0f3ed0fc749cd360d55ebba9a41465165f91a7ae974d6af4baed71109c2ad5b7f19514a6f510953fe3733b46d35f405e
-  data.tar.gz: 4ac4db65df766dd004c35e926a6a43e08023d86b4477d6e396b8c9ce9b125ee889bbbe86fecf7f6f4a60f847c2ae5d38beb829ce017957737de7a52f0ab802d3
+  metadata.gz: 12f8a447cf4f297bb4c07375d08efa41e5d1691a907ccbfdc7cef8c2f394cfc03a041318f76ab2475089b5d1b7438414cd00dca6305105bf616b3c2465b1c000
+  data.tar.gz: 0a7c13fec63e43adb8269d0639c1e4abfef77cba02a3a7b234716588e968116e1875e94bab08f68cdec60e656b65f159d42f308342eeac6f42846a6f5aec9b27

data/.rubocop.yml

@@ -5,6 +5,8 @@ AllCops:
     - vendor/**/*
     - example/**/*
   TargetRubyVersion: 2.7
+  UseCache: true
+  NewCops: enable
 
 #  Layout stuff
 #
@@ -27,25 +29,18 @@ Layout/SpaceAroundMethodCallOperator:
 
 #  Lint stuff
 #
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: true
-
-Lint/DuplicateElsifCondition:
-  Enabled: true
-
-Lint/MixedRegexpCaptureTypes:
-  Enabled: true
-
-Lint/RaiseException:
-  Enabled: true
-
-Lint/StructNewOverride:
+Lint/ConstantDefinitionInBlock:
   Enabled: true
+  Exclude:
+    - spec/**/*
 
 #  Metrics stuff
 #
 Metrics/AbcSize:
   Max: 25
+  IgnoredMethods:
+    # from lib/grape_entity/exposure/nesting_exposure.rb
+    - 'normalized_exposures'
 
 Metrics/BlockLength:
   Exclude:
@@ -64,6 +59,12 @@ Metrics/MethodLength:
 
 Metrics/PerceivedComplexity:
   Max: 11
+  IgnoredMethods:
+    # from lib/grape_entity/entity.rb
+    - 'expose'
+    - 'merge_options'
+    # from lib/grape_entity/exposure/nesting_exposure.rb
+    - 'normalized_exposures'
 
 #  Naming stuff
 #
@@ -73,56 +74,13 @@ Naming:
 
 #  Style stuff
 #
-Style/AccessorGrouping:
-  Enabled: true
-
-Style/ArrayCoercion:
-  Enabled: true
-
-Style/BisectedAttrAccessor:
-  Enabled: true
-
-Style/CaseLikeIf:
-  Enabled: true
-
 Style/Documentation:
   Enabled: false
 
-Style/ExponentialNotation:
-  Enabled: true
-
-Style/HashAsLastArrayItem:
-  Enabled: true
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashLikeCase:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/RedundantAssignment:
-  Enabled: true
-
-Style/RedundantFetchBlock:
-  Enabled: true
-
-Style/RedundantFileExtensionInRequire:
-  Enabled: true
-
-Style/RedundantRegexpCharacterClass:
-  Enabled: true
-
-Style/RedundantRegexpEscape:
-  Enabled: true
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/SlicingWithRange:
-  Enabled: true
+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,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-02-18 16:38:42 +0100 using RuboCop version 0.79.0.
+# on 2020-11-07 00:01:40 UTC using RuboCop version 1.2.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
@@ -14,17 +14,11 @@ Gemspec/RequiredRubyVersion:
     - 'grape-entity.gemspec'
 
 # Offense count: 6
+# Cop supports --auto-correct.
 Lint/BooleanSymbol:
   Exclude:
     - 'spec/grape_entity/exposure_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: inline, group
-Style/AccessModifierDeclarations:
-  Exclude:
-    - 'spec/grape_entity/entity_spec.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.

data/.travis.yml

@@ -9,17 +9,18 @@ after_success:
 rvm:
   - 2.5.8
   - 2.6.6
-  - 2.7.1
+  - 2.7.2
   - ruby-head
   - jruby-head
+  - truffleruby-head
+  - 2.4.10
+
 
 matrix:
   fast_finish: true
 
-  include:
-    - rvm: 2.4.10
-
   allow_failures:
     - rvm: 2.4.10
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: truffleruby-head

data/CHANGELOG.md

@@ -8,6 +8,15 @@
 
 * Your contribution here.
 
+
+### 0.8.2 (2020-11-08)
+
+#### Fixes
+
+* [#340](https://github.com/ruby-grape/grape-entity/pull/340): Preparations for 3.0 - [@LeFnord](https://github.com/LeFnord).
+* [#338](https://github.com/ruby-grape/grape-entity/pull/338): Fix ruby 2.7 deprecation warning - [@begotten63](https://github.com/begotten63).
+
+
 ### 0.8.1 (2020-07-15)
 
 #### Fixes
@@ -15,6 +24,7 @@
 * [#336](https://github.com/ruby-grape/grape-entity/pull/336): Pass options to delegators when they accept it - [@dnesteryuk](https://github.com/dnesteryuk).
 * [#333](https://github.com/ruby-grape/grape-entity/pull/333): Fix typo in CHANGELOG.md - [@eitoball](https://github.com/eitoball).
 
+
 ### 0.8.0 (2020-02-18)
 
 #### Features
@@ -30,12 +40,14 @@
 * [#320](https://github.com/ruby-grape/grape-entity/pull/320): Gemspec: drop eol'd property rubyforge_project - [@olleolleolle](https://github.com/olleolleolle).
 * [#307](https://github.com/ruby-grape/grape-entity/pull/307): Allow exposures to call methods defined in modules included in an entity - [@robertoz-01](https://github.com/robertoz-01).
 
+
 ### 0.7.1 (2018-01-30)
 
 #### Features
 
 * [#297](https://github.com/ruby-grape/grape-entity/pull/297): Introduce `override` option for expose (fixes [#286](https://github.com/ruby-grape/grape-entity/issues/296)) - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
 
+
 ### 0.7.0 (2018-01-25)
 
 #### Features
@@ -54,6 +66,7 @@
 * [#291](https://github.com/ruby-grape/grape-entity/pull/291): Refactor and simplify various classes and modules  - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
 * [#292](https://github.com/ruby-grape/grape-entity/pull/292): Allow replace non-conditional non-nesting exposures in child classes (fixes  [#286](https://github.com/ruby-grape/grape-entity/issues/286)) - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
 
+
 ### 0.6.1 (2017-01-09)
 
 #### Features
@@ -64,6 +77,7 @@
 
 * [#251](https://github.com/ruby-grape/grape-entity/pull/251): Avoid noise when code runs with Ruby warnings - [@cpetschnig](https://github.com/cpetschnig).
 
+
 ### 0.6.0 (2016-11-20)
 
 #### Features
@@ -75,6 +89,7 @@
 * [#249](https://github.com/ruby-grape/grape-entity/issues/249): Fix leaking of options and internals in default serialization - [@dblock](https://github.com/dblock), [@KingsleyKelly](https://github.com/KingsleyKelly).
 * [#248](https://github.com/ruby-grape/grape-entity/pull/248): Fix `nil` values causing errors when `merge` option passed - [@arempe93](https://github.com/arempe93).
 
+
 ### 0.5.2 (2016-11-14)
 
 #### Features
@@ -90,6 +105,7 @@
 * [#219](https://github.com/ruby-grape/grape-entity/pull/219): Double pass options in `serializable_hash` - [@sbatykov](https://github.com/sbatykov).
 * [#231](https://github.com/ruby-grape/grape-entity/pull/231), [#215](https://github.com/ruby-grape/grape-entity/issues/215): Allow `delegate_attribute` for derived entity - [@sbatykov](https://github.com/sbatykov).
 
+
 ### 0.5.1 (2016-4-4)
 
 #### Features
@@ -101,6 +117,7 @@
 
 * [#202](https://github.com/ruby-grape/grape-entity/pull/202): Reset `@using_class` memoization on `.setup` - [@rngtng](https://github.com/rngtng).
 
+
 ### 0.5.0 (2015-12-07)
 
 #### Features
@@ -121,18 +138,21 @@
 * [#151](https://github.com/ruby-grape/grape-entity/pull/151): Serializing of deeply nested presenter exposures: [#155](https://github.com/ruby-grape/grape-entity/issues/155) - [@marshall-lee](https://github.com/marshall-lee).
 * [#151](https://github.com/ruby-grape/grape-entity/pull/151): Deep projections (`:only`, `:except`) were unaware of nesting: [#156](https://github.com/ruby-grape/grape-entity/issues/156) - [@marshall-lee](https://github.com/marshall-lee).
 
+
 ### 0.4.8 (2015-08-10)
 
 #### Features
 
 * [#167](https://github.com/ruby-grape/grape-entity/pull/167), [#166](https://github.com/ruby-grape/grape-entity/issues/166): Regression with global settings (exposures, formatters) on `Grape::Entity` - [@marshall-lee](https://github.com/marshall-lee).
 
+
 ### 0.4.7 (2015-08-03)
 
 #### Features
 
 * [#164](https://github.com/ruby-grape/grape-entity/pull/164): Regression: entity instance methods were exposed with `NoMethodError`: [#163](https://github.com/ruby-grape/grape-entity/issues/163) - [@marshall-lee](https://github.com/marshall-lee).
 
+
 ### 0.4.6 (2015-07-27)
 
 #### Features
@@ -151,6 +171,7 @@
 
 * [#147](https://github.com/ruby-grape/grape-entity/pull/147), [#142](https://github.com/ruby-grape/grape-entity/pull/142): Private method values were not exposed with `safe` option - [@marshall-lee](https://github.com/marshall-lee).
 
+
 ### 0.4.5 (2015-03-10)
 
 #### Features
@@ -165,6 +186,7 @@
 * [#110](https://github.com/ruby-grape/grape-entity/pull/110): Safe exposure when using `Hash` models - [@croeck](https://github.com/croeck).
 * [#91](https://github.com/ruby-grape/grape-entity/pull/91): OpenStruct serializing - [@etehtsea](https://github.com/etehtsea).
 
+
 ### 0.4.4 (2014-08-17)
 
 #### Features
@@ -172,6 +194,7 @@
 * [#85](https://github.com/ruby-grape/grape-entity/pull/85): Added `present_collection` to indicate that an `Entity` presents an entire Collection - [@dspaeth-faber](https://github.com/dspaeth-faber).
 * [#85](https://github.com/ruby-grape/grape-entity/pull/85): Hashes can now be passed as object to be presented and the `Hash` keys can be referenced by expose - [@dspaeth-faber](https://github.com/dspaeth-faber).
 
+
 ### 0.4.3 (2014-06-12)
 
 #### Features
@@ -182,6 +205,7 @@
 
 * [#77](https://github.com/ruby-grape/grape-entity/pull/77): Compatibility with Rspec 3 - [@justfalter](https://github.com/justfalter).
 
+
 ### 0.4.2 (2014-04-03)
 
 #### Features
@@ -189,12 +213,14 @@
 * [#60](https://github.com/ruby-grape/grape-entity/issues/59): Performance issues introduced by nested exposures - [@AlexYankee](https://github.com/AlexYankee).
 * [#60](https://github.com/ruby-grape/grape-entity/issues/57): Nested exposure double-exposes a field - [@AlexYankee](https://github.com/AlexYankee).
 
+
 ### 0.4.1 (2014-02-13)
 
 #### Fixes
 
 * [#54](https://github.com/ruby-grape/grape-entity/issues/54): Fix: undefined method `to_set` - [@aj0strow](https://github.com/aj0strow).
 
+
 ### 0.4.0 (2014-01-27)
 
 #### Features
@@ -214,6 +240,7 @@
 * [#51](https://github.com/ruby-grape/grape-entity/pull/51): Raise `ArgumentError` if an unknown option is used with `expose` - [@aj0strow](https://github.com/aj0strow).
 * [#51](https://github.com/ruby-grape/grape-entity/pull/51): Alias `:with` to `:using`, consistently with the Grape api endpoints - [@aj0strow](https://github.com/aj0strow).
 
+
 ### 0.3.0 (2013-03-29)
 
 #### Features
@@ -222,12 +249,14 @@
 * The `instance.entity` method now optionally accepts `options` - [@mbleigh](https://github.com/mbleigh).
 * You can pass symbols to `:if` and `:unless` to simply check for truthiness/falsiness of the specified options key - [@mbleigh](https://github.com/mbleigh).
 
+
 ### 0.2.0 (2013-01-11)
 
 #### Features
 
 * Moved the namespace back to `Grape::Entity` to preserve compatibility with Grape - [@dblock](https://github.com/dblock).
 
+
 ### 0.1.0 (2013-01-11)
 
 * Initial public release - [@agileanimal](https://github.com/agileanimal).

data/Gemfile

@@ -5,7 +5,7 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubocop', '~> 0.88.0', require: false
+  gem 'rubocop', '~> 1.0', require: false
 end
 
 group :test do

data/UPGRADING.md

@@ -1,5 +1,34 @@
-Upgrading Grape Entity
-===============
+# Upgrading Grape Entity
+
+### Upgrading to >= 0.8.2
+
+In Ruby 3.0: the block handling will be changed
+[language-changes point 3, Proc](https://github.com/ruby/ruby/blob/v3_0_0_preview1/NEWS.md#language-changes).
+This:
+```ruby
+expose :that_method_without_args, &:method_without_args
+```
+will be deprecated.
+
+Prefer to use this pattern for simple setting a value
+```ruby
+expose :method_without_args, as: :that_method_without_args
+```
+
+### Upgrading to >= 0.8.2
+
+In Ruby 3.0: the block handling will be changed
+[language-changes point 3, Proc](https://github.com/ruby/ruby/blob/v3_0_0_preview1/NEWS.md#language-changes).
+This:
+```ruby
+expose :that_method_without_args, &:method_without_args
+```
+will be deprecated.
+
+Prefer to use this pattern for simple setting a value
+```ruby
+expose :method_without_args, as: :that_method_without_args
+```
 
 ### Upgrading to >= 0.6.0
 

data/lib/grape_entity.rb

@@ -9,3 +9,4 @@ require 'grape_entity/entity'
 require 'grape_entity/delegator'
 require 'grape_entity/exposure'
 require 'grape_entity/options'
+require 'grape_entity/deprecated'

data/lib/grape_entity/condition/base.rb

@@ -21,7 +21,7 @@ module Grape
         end
 
         def met?(entity, options)
-          !@inverse ? if_value(entity, options) : unless_value(entity, options)
+          @inverse ? unless_value(entity, options) : if_value(entity, options)
         end
 
         def if_value(_entity, _options)

data/lib/grape_entity/deprecated.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Grape
+  class Entity
+    class Deprecated < StandardError
+      def initialize(msg, spec)
+        message = "DEPRECATED #{spec}: #{msg}"
+
+        super(message)
+      end
+    end
+  end
+end

data/lib/grape_entity/entity.rb

@@ -139,6 +139,8 @@ module Grape
     def self.inherited(subclass)
       subclass.root_exposure = root_exposure.dup
       subclass.formatters = formatters.dup
+
+      super
     end
 
     # This method is the primary means by which you will declare what attributes
@@ -523,6 +525,11 @@ module Grape
       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
+      raise Grape::Entity::Deprecated.new e.message, 'in ruby 3.0' if e.is_a?(ArgumentError)
+
+      raise e.class, e.message
     end
 
     def exec_with_attribute(attribute, &block)
@@ -537,7 +544,7 @@ module Grape
       if is_defined_in_entity?(attribute)
         send(attribute)
       elsif @delegator_accepts_opts
-        delegator.delegate(attribute, self.class.delegation_opts)
+        delegator.delegate(attribute, **self.class.delegation_opts)
       else
         delegator.delegate(attribute)
       end

data/lib/grape_entity/exposure/base.rb

@@ -113,11 +113,9 @@ module Grape
           @key.respond_to?(:call) ? entity.exec_with_object(@options, &@key) : @key
         end
 
-        def with_attr_path(entity, options)
+        def with_attr_path(entity, options, &block)
           path_part = attr_path(entity, options)
-          options.with_attr_path(path_part) do
-            yield
-          end
+          options.with_attr_path(path_part, &block)
         end
 
         def override?

data/lib/grape_entity/exposure/nesting_exposure.rb

@@ -91,6 +91,7 @@ module Grape
             output[exposure.key(entity)] ||= []
             output[exposure.key(entity)] << exposure
           end
+
           table.map do |key, exposures|
             last_exposure = exposures.last
 

data/lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb

@@ -36,6 +36,7 @@ module Grape
             @exposures.clear
           end
 
+          # rubocop:disable Style/DocumentDynamicEvalDefinition
           %i[
             each
             to_ary to_a
@@ -55,6 +56,7 @@ module Grape
               end
             RUBY
           end
+          # rubocop:enable Style/DocumentDynamicEvalDefinition
 
           # Determine if we have any nesting exposures with the same name.
           def deep_complex_nesting?(entity)

data/lib/grape_entity/exposure/nesting_exposure/output_builder.rb

@@ -9,6 +9,8 @@ module Grape
             @entity = entity
             @output_hash = {}
             @output_collection = []
+
+            super
           end
 
           def add(exposure, result)
@@ -49,6 +51,7 @@ module Grape
             output
           end
 
+          # rubocop:disable Lint/EmptyBlock
           # In case if we want to solve collisions providing lambda to :merge option
           def merge_strategy(for_merge)
             if for_merge.respond_to? :call
@@ -57,6 +60,7 @@ module Grape
               -> {}
             end
           end
+          # rubocop:enable Lint/EmptyBlock
         end
       end
     end

data/lib/grape_entity/version.rb

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

data/spec/grape_entity/entity_spec.rb

@@ -30,7 +30,9 @@ describe Grape::Entity do
 
         it 'makes sure that :format_with as a proc cannot be used with a block' do
           # rubocop:disable Style/BlockDelimiters
+          # rubocop:disable Lint/EmptyBlock
           expect { subject.expose :name, format_with: proc {} do p 'hi' end }.to raise_error ArgumentError
+          # rubocop:enable Lint/EmptyBlock
           # rubocop:enable Style/BlockDelimiters
         end
 
@@ -260,27 +262,50 @@ describe Grape::Entity do
           end
         end
 
-        context 'with block passed via &' do
-          it 'with does not pass options when block is passed via &' do
-            class SomeObject
-              def method_without_args
-                'result'
-              end
+        describe 'blocks' do
+          class SomeObject
+            def method_without_args
+              'result'
             end
+          end
+
+          describe 'with block passed in' do
+            specify do
+              subject.expose :that_method_without_args do |object|
+                object.method_without_args
+              end
+
+              object = SomeObject.new
 
-            subject.expose :that_method_without_args do |object|
-              object.method_without_args
+              value = subject.represent(object).value_for(:that_method_without_args)
+              expect(value).to eq('result')
             end
+          end
+
+          context 'with block passed in via &' do
+            if RUBY_VERSION.start_with?('3')
+              specify do
+                subject.expose :that_method_without_args, &:method_without_args
+                subject.expose :method_without_args, as: :that_method_without_args_again
 
-            subject.expose :that_method_without_args_again, &:method_without_args
+                object = SomeObject.new
+                expect do
+                  subject.represent(object).value_for(:that_method_without_args)
+                end.to raise_error Grape::Entity::Deprecated
 
-            object = SomeObject.new
+                value2 = subject.represent(object).value_for(:that_method_without_args_again)
+                expect(value2).to eq('result')
+              end
+            else
+              specify do
+                subject.expose :that_method_without_args_again, &:method_without_args
 
-            value = subject.represent(object).value_for(:that_method_without_args)
-            expect(value).to eq('result')
+                object = SomeObject.new
 
-            value2 = subject.represent(object).value_for(:that_method_without_args_again)
-            expect(value2).to eq('result')
+                value2 = subject.represent(object).value_for(:that_method_without_args_again)
+                expect(value2).to eq('result')
+              end
+            end
           end
         end
 
@@ -1693,10 +1718,12 @@ describe Grape::Entity do
             end
           end
 
+          # rubocop:disable Lint/EmptyBlock
           fresh_class.class_eval do
             expose :first_friend, using: EntitySpec::FriendEntity do |_user, _opts|
             end
           end
+          # rubocop:enable Lint/EmptyBlock
 
           rep = subject.value_for(:first_friend)
           expect(rep).to be_kind_of EntitySpec::FriendEntity

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ SimpleCov.start do
   add_filter 'spec/'
 end
 
-Coveralls.wear!
+Coveralls.wear! unless RUBY_PLATFORM.eql? 'java'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -190,6 +190,7 @@ files:
 - lib/grape_entity/delegator/hash_object.rb
 - lib/grape_entity/delegator/openstruct_object.rb
 - lib/grape_entity/delegator/plain_object.rb
+- lib/grape_entity/deprecated.rb
 - lib/grape_entity/entity.rb
 - lib/grape_entity/exposure.rb
 - lib/grape_entity/exposure/base.rb
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.0.rc.1
 signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.