Preparations for 3.0 (#340)

* Preparations for 3.0 - ome maintainance tasks. - updates rubocop and make it happy - updates .travis matrix. - adds CHANGELOG and UPGRADE entries - did not run coveralls for jruby

Author: LeFnord

.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

CHANGELOG.md

@@ -6,6 +6,8 @@
 
 #### Fixes
 
+* Your contribution here.
+* [#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)

UPGRADING.md

@@ -1,5 +1,19 @@
-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.6.0
 

lib/grape_entity.rb

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

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

lib/grape_entity/entity.rb

@@ -525,6 +525,11 @@ def exec_with_object(options, &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
+ 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)

spec/grape_entity/entity_spec.rb

@@ -262,27 +262,50 @@ class BogusEntity < Grape::Entity
  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
 

spec/spec_helper.rb

@@ -13,7 +13,7 @@
  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'))