grape-entity 0.8.2 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa38cbc30d489d88e91c10c688c581251392a448330eca12ff79ebe22958bd9c
-  data.tar.gz: a96f1d0ada161d659f71aaca4e44588afc2727f4966e3f46058189483d46aa0c
+  metadata.gz: 9e3db71fd839585d80faac0980ec028b1204def600b6ce36101e2986e0be3cbf
+  data.tar.gz: 7bfcb78548991ed3ab73bfc1f23a51e1e32c2af7ccba472e87b9a767a9499c79
 SHA512:
-  metadata.gz: 12f8a447cf4f297bb4c07375d08efa41e5d1691a907ccbfdc7cef8c2f394cfc03a041318f76ab2475089b5d1b7438414cd00dca6305105bf616b3c2465b1c000
-  data.tar.gz: 0a7c13fec63e43adb8269d0639c1e4abfef77cba02a3a7b234716588e968116e1875e94bab08f68cdec60e656b65f159d42f308342eeac6f42846a6f5aec9b27
+  metadata.gz: 1ba1bf0a642f56275e8279b34d433591a21c7849ede46d0718fd6496831d4f5b5bd676bda0af6bf435beebe5c717ace6c0b53c1c90db92fdecccb8d88cdbe044
+  data.tar.gz: c06a650f7c29dd918fa8b83ab62dd04b91448bcddc440a43e48d055f5499982b6c4532f18abc7429f71f464895b083f8e551748c9d9fdf0f8072c2cd1af0e438

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# 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"

data/.github/workflows/rubocop.yml

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,26 @@
+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

data/.rspec

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

data/.rubocop.yml

@@ -4,9 +4,9 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
-  TargetRubyVersion: 2.7
-  UseCache: true
   NewCops: enable
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
 
 #  Layout stuff
 #

data/CHANGELOG.md

@@ -9,6 +9,31 @@
 * Your contribution here.
 
 
+### 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
+
+* [#352](https://github.com/ruby-grape/grape-entity/pull/352): Add Default value option - [@ahmednaguib](https://github.com/ahmednaguib).
+
+#### Fixes
+
+* [#355](https://github.com/ruby-grape/grape-entity/pull/355): Fix infinite loop problem with the `NameErrors` in block exposures - [@meinac](https://github.com/meinac).
+
+
+### 0.9.0 (2021-03-20)
+
+#### Features
+
+* [#346](https://github.com/ruby-grape/grape-entity/pull/346): Ruby 3 support - [@LeFnord](https://github.com/LeFnord).
+
+
 ### 0.8.2 (2020-11-08)
 
 #### Fixes

data/Gemfile

@@ -15,6 +15,6 @@ group :test do
   gem 'guard-bundler'
   gem 'guard-rspec'
   gem 'rb-fsevent'
-  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'ruby-grape-danger', '~> 0.2', require: false
   gem 'simplecov', require: false
 end

data/README.md

@@ -1,10 +1,47 @@
-# Grape::Entity
-
 [![Gem Version](http://img.shields.io/gem/v/grape-entity.svg)](http://badge.fury.io/rb/grape-entity)
-[![Build Status](http://img.shields.io/travis/ruby-grape/grape-entity.svg)](https://travis-ci.org/ruby-grape/grape-entity)
+![Ruby](https://github.com/ruby-grape/grape-entity/workflows/Ruby/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-entity/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-entity?branch=master)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-entity.svg)](https://codeclimate.com/github/ruby-grape/grape-entity)
 
+# Table of Contents
+
+- [Grape::Entity](#grapeentity)
+  - [Introduction](#introduction)
+    - [Example](#example)
+  - [Reusable Responses with Entities](#reusable-responses-with-entities)
+    - [Defining Entities](#defining-entities)
+      - [Basic Exposure](#basic-exposure)
+      - [Exposing with a Presenter](#exposing-with-a-presenter)
+      - [Conditional Exposure](#conditional-exposure)
+      - [Safe Exposure](#safe-exposure)
+      - [Nested Exposure](#nested-exposure)
+      - [Collection Exposure](#collection-exposure)
+      - [Merge Fields](#merge-fields)
+      - [Runtime Exposure](#runtime-exposure)
+      - [Unexpose](#unexpose)
+      - [Overriding exposures](#overriding-exposures)
+      - [Returning only the fields you want](#returning-only-the-fields-you-want)
+      - [Aliases](#aliases)
+      - [Format Before Exposing](#format-before-exposing)
+      - [Expose Nil](#expose-nil)
+      - [Default Value](#default-value)
+      - [Documentation](#documentation)
+    - [Options Hash](#options-hash)
+      - [Passing Additional Option To Nested Exposure](#passing-additional-option-to-nested-exposure)
+      - [Attribute Path Tracking](#attribute-path-tracking)
+    - [Using the Exposure DSL](#using-the-exposure-dsl)
+    - [Using Entities](#using-entities)
+    - [Entity Organization](#entity-organization)
+    - [Caveats](#caveats)
+  - [Installation](#installation)
+  - [Testing with Entities](#testing-with-entities)
+  - [Project Resources](#project-resources)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Copyright](#copyright)
+
+# Grape::Entity
+
 ## Introduction
 
 This gem adds Entity support to API frameworks, such as [Grape](https://github.com/ruby-grape/grape). Grape's Entity is an API focused facade that sits on top of an object model.
@@ -74,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.
@@ -446,6 +497,19 @@ module  Entities
 end
 ```
 
+#### Default Value
+
+This option can be used to provide a default value in case the return value is nil or empty.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    expose :name, default: ''
+    expose :age, default: 60
+  end
+end
+```
+
 #### Documentation
 
 Expose documentation with the field. Gets bubbled up when used with Grape and various API documentation systems.

data/UPGRADING.md

@@ -1,22 +1,10 @@
 # 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
 
+Official support for ruby < 2.5 removed, ruby 2.5 only in testing mode, but no support.
+
 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:

data/grape-entity.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_runtime_dependency 'activesupport', '>= 3.0.0'
   # FIXME: remove dependecy

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

@@ -122,8 +122,6 @@ module Grape
           case value
           when :to_s, :str, :string
             :to_s
-          when :to_sym, :sym, :symbol
-            :to_sym
           else
             :to_sym
           end
@@ -155,7 +153,7 @@ module Grape
     #
     # @example as: a proc or lambda
     #
-    #   object = OpenStruct(awesomness: 'awesome_key', awesome: 'not-my-key', other: 'other-key' )
+    #   object = OpenStruct(awesomeness: 'awesome_key', awesome: 'not-my-key', other: 'other-key' )
     #
     #   class MyEntity < Grape::Entity
     #     expose :awesome, as: proc { object.awesomeness }
@@ -483,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
@@ -529,7 +524,7 @@ module Grape
       # 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
+      raise e
     end
 
     def exec_with_attribute(attribute, &block)
@@ -543,7 +538,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)
@@ -587,6 +582,7 @@ module Grape
       merge
       expose_nil
       override
+      default
     ].to_set.freeze
 
     # Merges the given options with current block options.

data/lib/grape_entity/exposure/base.rb

@@ -16,6 +16,7 @@ module Grape
           key = options[:as] || attribute
           @key = key.respond_to?(:to_sym) ? key.to_sym : key
           @is_safe = options[:safe]
+          @default_value = options[:default]
           @for_merge = options[:merge]
           @attr_path_proc = options[:attr_path]
           @documentation = options[:documentation]
@@ -82,7 +83,10 @@ module Grape
         end
 
         def valid_value(entity, options)
-          value(entity, options) if valid?(entity)
+          return unless valid?(entity)
+
+          output = value(entity, options)
+          output.blank? && @default_value.present? ? @default_value : output
         end
 
         def should_return_key?(options)

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

@@ -51,7 +51,6 @@ 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
@@ -60,7 +59,6 @@ module Grape
               -> {}
             end
           end
-          # rubocop:enable Lint/EmptyBlock
         end
       end
     end

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/version.rb

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

data/spec/grape_entity/entity_spec.rb

@@ -30,9 +30,7 @@ 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
 
@@ -214,6 +212,130 @@ describe Grape::Entity do
         end
       end
 
+      context 'with :default option' do
+        let(:a) { nil }
+        let(:b) { nil }
+        let(:c) { 'value' }
+
+        context 'when model is a PORO' do
+          let(:model) { Model.new(a, b, c) }
+
+          before do
+            stub_const 'Model', Class.new
+            Model.class_eval do
+              attr_accessor :a, :b, :c
+
+              def initialize(a, b, c)
+                @a = a
+                @b = b
+                @c = c
+              end
+            end
+          end
+
+          context 'when default option is not provided' do
+            it 'exposes attributes values' do
+              subject.expose(:a)
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(a: nil, b: nil, c: 'value')
+            end
+          end
+
+          context 'when default option is set' do
+            it 'exposes default values for attributes' do
+              subject.expose(:a, default: 'a')
+              subject.expose(:b, default: 'b')
+              subject.expose(:c, default: 'c')
+              expect(subject.represent(model).serializable_hash).to eq(a: 'a', b: 'b', c: 'value')
+            end
+          end
+
+          context 'when default option is set and block passed' do
+            it 'return default value if block returns nil' do
+              subject.expose(:a, default: 'a') do |_obj, _options|
+                nil
+              end
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(a: 'a', b: nil, c: 'value')
+            end
+
+            it 'return value from block if block returns a value' do
+              subject.expose(:a, default: 'a') 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
+          let(:model) { { a: a, b: b, c: c } }
+
+          context 'when expose_nil option is not provided' do
+            it 'exposes nil attributes' do
+              subject.expose(:a)
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(a: nil, b: nil, c: 'value')
+            end
+          end
+
+          context 'when expose_nil option is true' do
+            it 'exposes nil attributes' do
+              subject.expose(:a, expose_nil: true)
+              subject.expose(:b, expose_nil: true)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(a: nil, b: nil, c: 'value')
+            end
+          end
+
+          context 'when expose_nil option is false' do
+            it 'does not expose nil attributes' do
+              subject.expose(:a, expose_nil: false)
+              subject.expose(:b, expose_nil: false)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(c: 'value')
+            end
+
+            it 'is only applied per attribute' do
+              subject.expose(:a, expose_nil: false)
+              subject.expose(:b)
+              subject.expose(:c)
+              expect(subject.represent(model).serializable_hash).to eq(b: nil, c: 'value')
+            end
+
+            it 'raises an error when applied to multiple attribute exposures' do
+              expect { subject.expose(:a, :b, :c, expose_nil: false) }.to raise_error ArgumentError
+            end
+          end
+        end
+
+        context 'with nested structures' do
+          let(:model) { { a: a, b: b, c: { d: nil, e: nil, f: { g: nil, h: nil } } } }
+
+          context 'when expose_nil option is false' do
+            it 'does not expose nil attributes' do
+              subject.expose(:a, expose_nil: false)
+              subject.expose(:b)
+              subject.expose(:c) do
+                subject.expose(:d, expose_nil: false)
+                subject.expose(:e)
+                subject.expose(:f) do
+                  subject.expose(:g, expose_nil: false)
+                  subject.expose(:h)
+                end
+              end
+
+              expect(subject.represent(model).serializable_hash).to eq(b: nil, c: { e: nil, f: { h: nil } })
+            end
+          end
+        end
+      end
+
       context 'with a block' do
         it 'errors out if called with multiple attributes' do
           expect { subject.expose(:name, :email) { true } }.to raise_error ArgumentError
@@ -1137,6 +1259,18 @@ describe Grape::Entity do
             expect(representation).to eq(id: nil, name: nil, user: { id: nil, name: nil, email: nil })
           end
         end
+
+        context 'when NameError happens in a parameterized block_exposure' do
+          before do
+            subject.expose :raise_no_method_error do |_|
+              foo
+            end
+          end
+
+          it 'does not cause infinite loop' do
+            expect { subject.represent({}, serializable: true) }.to raise_error(NameError)
+          end
+        end
       end
     end
 
@@ -1581,7 +1715,7 @@ describe Grape::Entity do
           end
 
           fresh_class.class_eval do
-            expose :characteristics, using: EntitySpec::NoPathCharacterEntity, attr_path: proc { nil }
+            expose :characteristics, using: EntitySpec::NoPathCharacterEntity, attr_path: proc {}
           end
 
           expect(subject.serializable_hash).to eq(

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))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.10.1
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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
@@ -223,14 +225,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-
-before_install:
-  - gem install bundler
-
-after_success:
-  - bundle exec danger
-
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - ruby-head
-  - jruby-head
-  - truffleruby-head
-  - 2.4.10
-
-
-matrix:
-  fast_finish: true
-
-  allow_failures:
-    - rvm: 2.4.10
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby-head