grape-entity 0.7.0 → 0.9.0

data/lib/grape_entity/exposure/nesting_exposure.rb

@@ -87,9 +87,11 @@ module Grape
               exposure.should_expose?(entity, options)
             end
             next unless should_expose
+
             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
@@ -49,12 +50,13 @@ module Grape
             length
             empty?
           ].each do |name|
-            class_eval <<-RUBY, __FILE__, __LINE__
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
               def #{name}(*args, &block)
                 @exposures.#{name}(*args, &block)
               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)
@@ -19,6 +21,7 @@ module Grape
               # If we have an array which should not be merged - save it with a key as a hash
               # If we have hash which should be merged - save it without a key (merge)
               return unless result
+
               @output_hash.merge! result, &merge_strategy(exposure.for_merge)
             else
               @output_hash[exposure.key(@entity)] = result

data/lib/grape_entity/options.rb

@@ -106,11 +106,12 @@ module Grape
       end
 
       def build_symbolized_hash(attribute, hash)
-        if attribute.is_a?(Hash)
+        case attribute
+        when Hash
           attribute.each do |attr, nested_attrs|
             hash[attr.to_sym] = build_symbolized_hash(nested_attrs, {})
           end
-        elsif attribute.is_a?(Array)
+        when Array
           return attribute.each { |x| build_symbolized_hash(x, {}) }
         else
           hash[attribute.to_sym] = true

data/lib/grape_entity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeEntity
-  VERSION = '0.7.0'
+  VERSION = '0.9.0'
 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
 
@@ -126,6 +128,26 @@ describe Grape::Entity do
               expect { subject.expose(:a, :b, :c, expose_nil: false) }.to raise_error ArgumentError
             end
           end
+
+          context 'when expose_nil option is false and block passed' do
+            it 'does not expose if block returns nil' do
+              subject.expose(:a, expose_nil: false) do |_obj, _options|
+                nil
+              end
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(b: nil, c: 'value')
+            end
+
+            it 'exposes is block returns a value' do
+              subject.expose(:a, expose_nil: false) do |_obj, _options|
+                100
+              end
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(a: 100, b: nil, c: 'value')
+            end
+          end
         end
 
         context 'when model is a hash' do
@@ -240,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
 
@@ -477,11 +522,20 @@ describe Grape::Entity do
           expect(child_class.represent({ name: 'bar' }, serializable: true)).to eq(email: nil, name: 'foo')
         end
 
-        it 'overrides parent class exposure' do
+        it 'not overrides exposure by default' do
           subject.expose :name
           child_class = Class.new(subject)
           child_class.expose :name, as: :child_name
 
+          expect(subject.represent({ name: 'bar' }, serializable: true)).to eq(name: 'bar')
+          expect(child_class.represent({ name: 'bar' }, serializable: true)).to eq(name: 'bar', child_name: 'bar')
+        end
+
+        it 'overrides parent class exposure when option is specified' do
+          subject.expose :name
+          child_class = Class.new(subject)
+          child_class.expose :name, as: :child_name, override: true
+
           expect(subject.represent({ name: 'bar' }, serializable: true)).to eq(name: 'bar')
           expect(child_class.represent({ name: 'bar' }, serializable: true)).to eq(child_name: 'bar')
         end
@@ -948,7 +1002,7 @@ describe Grape::Entity do
           subject.expose(:user, using: user_entity)
 
           representation = subject.represent(OpenStruct.new(user: {}),
-                                             only: [:id, :name, :phone, user: %i[id name email]],
+                                             only: [:id, :name, :phone, { user: %i[id name email] }],
                                              except: [:phone, { user: [:id] }], serializable: true)
           expect(representation).to eq(id: nil, name: nil, user: { name: nil, email: nil })
         end
@@ -1367,6 +1421,18 @@ describe Grape::Entity do
         expect(res).to have_key :nonexistent_attribute
       end
 
+      it 'exposes attributes defined through module inclusion' do
+        module SharedAttributes
+          def a_value
+            3.14
+          end
+        end
+        fresh_class.include(SharedAttributes)
+        fresh_class.expose :a_value
+        res = fresh_class.new(model).serializable_hash
+        expect(res[:a_value]).to eq(3.14)
+      end
+
       it 'does not expose attributes that are generated by a block but have not passed criteria' do
         fresh_class.expose :nonexistent_attribute,
                            proc: ->(_, _) { 'I exist, but it is not yet my time to shine' },
@@ -1652,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/grape_entity/exposure/represent_exposure_spec.rb

@@ -12,11 +12,11 @@ describe Grape::Entity::Exposure::RepresentExposure do
     let(:subexposure)      { double(:subexposure) }
 
     it 'sets using_class_name' do
-      expect { subject }.to change { exposure.using_class_name }.to(using_class_name)
+      expect { subject }.to change(exposure, :using_class_name).to(using_class_name)
     end
 
     it 'sets subexposure' do
-      expect { subject }.to change { exposure.subexposure }.to(subexposure)
+      expect { subject }.to change(exposure, :subexposure).to(subexposure)
     end
 
     context 'when using_class is set' do
@@ -25,7 +25,7 @@ describe Grape::Entity::Exposure::RepresentExposure do
       end
 
       it 'resets using_class' do
-        expect { subject }.to change { exposure.using_class }
+        expect { subject }.to change(exposure, :using_class)
       end
     end
   end

data/spec/grape_entity/hash_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Grape::Entity do
-  it 'except option for nested entity' do
+  it 'except option for nested entity', :aggregate_failures do
     module EntitySpec
       class Address < Grape::Entity
         expose :post, if: :full
@@ -12,6 +12,14 @@ describe Grape::Entity do
         expose :house
       end
 
+      class AddressWithString < Grape::Entity
+        self.hash_access = :string
+        expose :post, if: :full
+        expose :city
+        expose :street
+        expose :house
+      end
+
       class Company < Grape::Entity
         expose :full_name, if: :full
         expose :name
@@ -19,6 +27,15 @@ describe Grape::Entity do
           Address.represent c[:address], Grape::Entity::Options.new(o.opts_hash.except(:full))
         end
       end
+
+      class CompanyWithString < Grape::Entity
+        self.hash_access = :string
+        expose :full_name, if: :full
+        expose :name
+        expose :address do |c, o|
+          AddressWithString.represent c['address'], Grape::Entity::Options.new(o.opts_hash.except(:full))
+        end
+      end
     end
 
     company = {
@@ -33,6 +50,24 @@ describe Grape::Entity do
       }
     }
 
+    company_with_string = {
+      'full_name' => 'full_name',
+      'name' => 'name',
+      'address' => {
+        'post' => '123456',
+        'city' => 'city',
+        'street' => 'street',
+        'house' => 'house',
+        '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_with_string, full: true).serializable_hash).to eq \
+      company.slice(:full_name, :name).merge(address: company[:address].slice(:city, :street, :house))
+
     expect(EntitySpec::Company.represent(company).serializable_hash).to eq \
       company.slice(:name).merge(address: company[:address].slice(:city, :street, :house))
 

data/spec/spec_helper.rb

@@ -3,11 +3,17 @@
 require 'simplecov'
 require 'coveralls'
 
+# This works around the hash extensions not being automatically included in ActiveSupport < 4
+require 'active_support/version'
+require 'active_support/core_ext/hash' if ActiveSupport::VERSION &&
+                                          ActiveSupport::VERSION::MAJOR &&
+                                          ActiveSupport::VERSION::MAJOR < 4
+
 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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2021-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -159,11 +159,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -190,6 +192,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
@@ -214,7 +217,7 @@ homepage: https://github.com/ruby-grape/grape-entity
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,16 +225,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: grape-entity
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
 test_files: