grape-entity 0.6.0 → 0.10.1

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)
-[![Dependency Status](https://gemnasium.com/ruby-grape/grape-entity.svg)](https://gemnasium.com/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.
@@ -220,7 +271,8 @@ class ExampleEntity < Grape::Entity
 end
 ```
 
-You have always access to the presented instance with `object`
+You always have access to the presented instance (`object`) and the top-level
+entity options (`options`).
 
 ```ruby
 class ExampleEntity < Grape::Entity
@@ -229,7 +281,7 @@ class ExampleEntity < Grape::Entity
   private
 
   def formatted_value
-    "+ X #{object.value}"
+    "+ X #{object.value} #{options[:y]}"
   end
 end
 ```
@@ -255,6 +307,22 @@ class MailingAddress < UserData
 end
 ```
 
+#### Overriding exposures
+
+If you want to add one more exposure for the field but don't want the first one to be fired (for instance, when using inheritance), you can use the `override` flag. For instance:
+
+```ruby
+class User < Grape::Entity
+  expose :name
+end
+
+class Employee < User
+  expose :name, as: :employee_name, override: true
+end
+```
+
+`User` will return something like this `{ "name" : "John" }` while `Employee` will present the same data as `{ "employee_name" : "John" }` instead of `{ "name" : "John", "employee_name" : "John" }`.
+
 #### Returning only the fields you want
 
 After exposing the desired attributes, you can choose which one you need when representing some object or collection by using the only: and except: options. See the example:
@@ -320,7 +388,7 @@ module Entities
     with_options(format_with: :iso_timestamp) do
       expose :created_at
       expose :updated_at
-    end    
+    end
   end
 end
 ```
@@ -349,6 +417,99 @@ module Entities
 end
 ```
 
+#### Expose Nil
+
+By default, exposures that contain `nil` values will be represented in the resulting JSON as `null`.
+
+As an example, a hash with the following values:
+
+```ruby
+{
+  name: nil,
+  age: 100
+}
+```
+
+will result in a JSON object that looks like:
+
+```javascript
+{
+  "name": null,
+  "age": 100
+}
+```
+
+There are also times when, rather than displaying an attribute with a `null` value, it is more desirable to not display the attribute at all. Using the hash from above the desired JSON would look like:
+
+```javascript
+{
+  "age": 100
+}
+```
+
+In order to turn on this behavior for an as-exposure basis, the option `expose_nil` can be used. By default, `expose_nil` is considered to be `true`, meaning that `nil` values will be represented in JSON as `null`. If `false` is provided, then attributes with `nil` values will be omitted from the resulting JSON completely.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    expose :name, expose_nil: false
+    expose :age, expose_nil: false
+  end
+end
+```
+
+`expose_nil` is per exposure, so you can suppress exposures from resulting in `null` or express `null` values on a per exposure basis as you need:
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    expose :name, expose_nil: false
+    expose :age # since expose_nil is omitted nil values will be rendered as null
+  end
+end
+```
+
+It is also possible to use `expose_nil` with `with_options` if you want to add the configuration to multiple exposures at once.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    # None of the exposures in the with_options block will render nil values as null
+    with_options(expose_nil: false) do
+      expose :name
+      expose :age
+    end
+  end
+end
+```
+
+When using `with_options`, it is possible to again override which exposures will render `nil` as `null` by adding the option on a specific exposure.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    # None of the exposures in the with_options block will render nil values as null
+    with_options(expose_nil: false) do
+      expose :name
+      expose :age, expose_nil: true # nil values would be rendered as null in the JSON
+    end
+  end
+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/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
@@ -17,4 +17,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[spec rubocop]

data/UPGRADING.md

@@ -1,5 +1,22 @@
-Upgrading Grape Entity
-===============
+# Upgrading Grape Entity
+
+
+### 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:
+```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/bench/serializing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'grape-entity'
 require 'benchmark'
@@ -5,6 +7,7 @@ require 'benchmark'
 module Models
   class School
     attr_reader :classrooms
+
     def initialize
       @classrooms = []
     end
@@ -13,6 +16,7 @@ module Models
   class ClassRoom
     attr_reader :students
     attr_accessor :teacher
+
     def initialize(opts = {})
       @teacher = opts[:teacher]
       @students = []
@@ -21,6 +25,7 @@ module Models
 
   class Person
     attr_accessor :name
+
     def initialize(opts = {})
       @name = opts[:name]
     end
@@ -28,6 +33,7 @@ module Models
 
   class Teacher < Models::Person
     attr_accessor :tenure
+
     def initialize(opts = {})
       super(opts)
       @tenure = opts[:tenure]
@@ -36,6 +42,7 @@ module Models
 
   class Student < Models::Person
     attr_reader :grade
+
     def initialize(opts = {})
       super(opts)
       @grade = opts[:grade]

data/grape-entity.gemspec

@@ -1,4 +1,6 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'grape_entity/version'
 
 Gem::Specification.new do |s|
@@ -12,20 +14,20 @@ Gem::Specification.new do |s|
   s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
-  s.rubyforge_project = 'grape-entity'
+  s.required_ruby_version = '>= 2.5'
 
+  s.add_runtime_dependency 'activesupport', '>= 3.0.0'
+  # FIXME: remove dependecy
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-  s.add_runtime_dependency 'activesupport'
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop', '~> 0.40'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'maruku'
-  s.add_development_dependency 'yard'
   s.add_development_dependency 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
   s.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'yard'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

data/lib/grape-entity.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'grape_entity'

data/lib/grape_entity/condition/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
@@ -19,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/condition/block_condition.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition
       class BlockCondition < Base
         attr_reader :block
 
-        def setup(&block)
+        def setup(block)
           @block = block
         end
 

data/lib/grape_entity/condition/hash_condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition

data/lib/grape_entity/condition/symbol_condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Condition

data/lib/grape_entity/condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/condition/base'
 require 'grape_entity/condition/block_condition'
 require 'grape_entity/condition/hash_condition'
@@ -6,19 +8,26 @@ require 'grape_entity/condition/symbol_condition'
 module Grape
   class Entity
     module Condition
-      def self.new_if(arg)
-        case arg
-        when Hash then HashCondition.new false, arg
-        when Proc then BlockCondition.new false, &arg
-        when Symbol then SymbolCondition.new false, arg
+      class << self
+        def new_if(arg)
+          condition(false, arg)
         end
-      end
 
-      def self.new_unless(arg)
-        case arg
-        when Hash then HashCondition.new true, arg
-        when Proc then BlockCondition.new true, &arg
-        when Symbol then SymbolCondition.new true, arg
+        def new_unless(arg)
+          condition(true, arg)
+        end
+
+        private
+
+        def condition(inverse, arg)
+          condition_klass =
+            case arg
+            when Hash then HashCondition
+            when Proc then BlockCondition
+            when Symbol then SymbolCondition
+            end
+
+          condition_klass.new(inverse, arg)
         end
       end
     end

data/lib/grape_entity/delegator/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
@@ -11,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/fetchable_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator

data/lib/grape_entity/delegator/hash_object.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator
       class HashObject < Base
-        def delegate(attribute)
-          object[attribute]
+        def delegate(attribute, hash_access: :to_sym)
+          object[attribute.send(hash_access)]
         end
       end
     end

data/lib/grape_entity/delegator/openstruct_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator

data/lib/grape_entity/delegator/plain_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Delegator

data/lib/grape_entity/delegator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/delegator/base'
 require 'grape_entity/delegator/hash_object'
 require 'grape_entity/delegator/openstruct_object'
@@ -8,15 +10,18 @@ module Grape
   class Entity
     module Delegator
       def self.new(object)
-        if object.is_a?(Hash)
-          HashObject.new object
-        elsif defined?(OpenStruct) && object.is_a?(OpenStruct)
-          OpenStructObject.new object
-        elsif object.respond_to? :fetch, true
-          FetchableObject.new object
-        else
-          PlainObject.new object
-        end
+        delegator_klass =
+          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)
       end
     end
   end

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