grape-entity 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecd89442adb3e014be540761d005b20920e8aa847691a69a6c4e166d1ed63f21
-  data.tar.gz: c556531fdea49f03dfea0ce4d1388016736c7d3987db0957be30b27a82e21e40
+  metadata.gz: 31f997094eb9145e0e34541cc1083562afbc7724f68c343d9bb8f897b1af8c5f
+  data.tar.gz: 271397df6ac51ffdd5e6380a1e4ab47affb3fbb14d805f6d00cc6715084d0f13
 SHA512:
-  metadata.gz: 5a48af786a0d681229aecd0765eccfafb9f28f6178dc5ade649d54b255df13e82f24f4f5243de7cdff9d45a423d101b851137ffb7920e3853529d88fbe23f67b
-  data.tar.gz: b9b89ee602c3804470c57e6519244e59b78fa5b10470fb2a5d0f1581e821847ab8a6f66145fcf57445090d654c442d33cfc6fa94c6eaea9e36f15ce1038eb362
+  metadata.gz: '0916c3b71d39463de13549202659f8e2c60634e6e6951b9999d45a045307c716f7bcada5a86c100066029a8e4f7da7aea5bf296bc8659f9a871162118c196d3d'
+  data.tar.gz: ed8956de1f403808e504a60b3759e19a0012f9d91db9200fc63891f7d5f5bc29116084619bd47e41d8afce3ef8a98180c620c1f902b3f0dbd4eb42f37d4bb596

data/.rubocop_todo.yml

@@ -18,7 +18,7 @@ Metrics/AbcSize:
 # Offense count: 35
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 1625
+  Max: 1632
 
 # Offense count: 2
 # Configuration parameters: CountComments.

data/CHANGELOG.md

@@ -8,6 +8,12 @@
 
 * Your contribution here.
 
+### 0.7.1 (2018-01-30)
+
+#### Features
+
+* [#292](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

data/README.md

@@ -256,6 +256,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 < UserData
+  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:

data/lib/grape_entity/entity.rb

@@ -197,7 +197,7 @@ module Grape
 
       exposure = Exposure.new(attribute, options)
 
-      exposure_list.delete_by(attribute) if exposure_list.select_by(attribute).all? { |exp| exp.replaceable_by?(exposure) }
+      exposure_list.delete_by(attribute) if exposure.override?
 
       exposure_list << exposure
 
@@ -527,7 +527,7 @@ module Grape
 
     # All supported options.
     OPTIONS = %i[
-      rewrite as if unless using with proc documentation format_with safe attr_path if_extras unless_extras merge expose_nil
+      rewrite as if unless using with proc documentation format_with safe attr_path if_extras unless_extras merge expose_nil override
     ].to_set.freeze
 
     # Merges the given options with current block options.

data/lib/grape_entity/exposure/base.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Exposure
       class Base
-        attr_reader :attribute, :is_safe, :documentation, :conditions, :for_merge
+        attr_reader :attribute, :is_safe, :documentation, :override, :conditions, :for_merge
 
         def self.new(attribute, options, conditions, *args, &block)
           super(attribute, options, conditions).tap { |e| e.setup(*args, &block) }
@@ -19,6 +19,7 @@ module Grape
           @for_merge = options[:merge]
           @attr_path_proc = options[:attr_path]
           @documentation = options[:documentation]
+          @override = options[:override]
           @conditions = conditions
         end
 
@@ -116,8 +117,8 @@ module Grape
           end
         end
 
-        def replaceable_by?(other)
-          !nesting? && !conditional? && !other.nesting? && !other.conditional?
+        def override?
+          @override
         end
 
         protected

data/lib/grape_entity/version.rb

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

data/spec/grape_entity/entity_spec.rb

@@ -477,11 +477,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-25 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport