grape-entity 0.6.1 → 0.7.0

data/lib/grape_entity/condition/base.rb

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

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/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,14 @@ 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) then HashObject
+          elsif defined?(OpenStruct) && object.is_a?(OpenStruct) then OpenStructObject
+          elsif object.respond_to?(:fetch, true) then FetchableObject
+          else PlainObject
+          end
+
+        delegator_klass.new(object)
       end
     end
   end

data/lib/grape_entity/delegator/base.rb

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'multi_json'
 require 'set'
 
@@ -124,7 +126,26 @@ module Grape
     # This method is the primary means by which you will declare what attributes
     # should be exposed by the entity.
     #
+    # @option options :expose_nil When set to false the associated exposure will not
+    #   be rendered if its value is nil.
+    #
     # @option options :as Declare an alias for the representation of this attribute.
+    #   If a proc is presented it is evaluated in the context of the entity so object
+    #   and the entity methods are available to it.
+    #
+    # @example as: a proc or lambda
+    #
+    #   object = OpenStruct(awesomness: 'awesome_key', awesome: 'not-my-key', other: 'other-key' )
+    #
+    #   class MyEntity < Grape::Entity
+    #     expose :awesome, as: proc { object.awesomeness }
+    #     expose :awesomeness, as: ->(object, opts) { object.other }
+    #   end
+    #
+    #   => { 'awesome_key': 'not-my-key', 'other-key': 'awesome_key' }
+    #
+    # Note the parameters passed in via the lambda syntax.
+    #
     # @option options :if When passed a Hash, the attribute will only be exposed if the
     #   runtime options match all the conditions passed in. When passed a lambda, the
     #   lambda will execute with two arguments: the object being represented and the
@@ -152,6 +173,7 @@ module Grape
 
       if args.size > 1
         raise ArgumentError, 'You may not use the :as option on multi-attribute exposures.' if options[:as]
+        raise ArgumentError, 'You may not use the :expose_nil on multi-attribute exposures.' if options.key?(:expose_nil)
         raise ArgumentError, 'You may not use block-setting on multi-attribute exposures.' if block_given?
       end
 
@@ -167,24 +189,24 @@ module Grape
 
       @documentation = nil
       @nesting_stack ||= []
+      args.each { |attribute| build_exposure_for_attribute(attribute, @nesting_stack, options, block) }
+    end
 
-      # rubocop:disable Style/Next
-      args.each do |attribute|
-        exposure = Exposure.new(attribute, options)
+    def self.build_exposure_for_attribute(attribute, nesting_stack, options, block)
+      exposure_list = nesting_stack.empty? ? root_exposures : nesting_stack.last.nested_exposures
 
-        if @nesting_stack.empty?
-          root_exposures << exposure
-        else
-          @nesting_stack.last.nested_exposures << exposure
-        end
+      exposure = Exposure.new(attribute, options)
 
-        # Nested exposures are given in a block with no parameters.
-        if exposure.nesting?
-          @nesting_stack << exposure
-          block.call
-          @nesting_stack.pop
-        end
-      end
+      exposure_list.delete_by(attribute) if exposure_list.select_by(attribute).all? { |exp| exp.replaceable_by?(exposure) }
+
+      exposure_list << exposure
+
+      # Nested exposures are given in a block with no parameters.
+      return unless exposure.nesting?
+
+      nesting_stack << exposure
+      block.call
+      nesting_stack.pop
     end
 
     # Returns exposures that have been declared for this Entity on the top level.
@@ -237,9 +259,7 @@ module Grape
     # #docmentation, any exposure without a documentation key will be ignored.
     def self.documentation
       @documentation ||= root_exposures.each_with_object({}) do |exposure, memo|
-        if exposure.documentation && !exposure.documentation.empty?
-          memo[exposure.key] = exposure.documentation
-        end
+        memo[exposure.key] = exposure.documentation if exposure.documentation && !exposure.documentation.empty?
       end
     end
 
@@ -434,12 +454,8 @@ module Grape
 
     def initialize(object, options = {})
       @object = object
-      @delegator = Delegator.new object
-      @options = if options.is_a? Options
-                   options
-                 else
-                   Options.new options
-                 end
+      @delegator = Delegator.new(object)
+      @options = options.is_a?(Options) ? options : Options.new(options)
     end
 
     def root_exposures
@@ -474,7 +490,11 @@ module Grape
     end
 
     def exec_with_object(options, &block)
-      instance_exec(object, options, &block)
+      if block.parameters.count == 1
+        instance_exec(object, &block)
+      else
+        instance_exec(object, options, &block)
+      end
     end
 
     def exec_with_attribute(attribute, &block)
@@ -506,8 +526,8 @@ module Grape
     end
 
     # All supported options.
-    OPTIONS = [
-      :rewrite, :as, :if, :unless, :using, :with, :proc, :documentation, :format_with, :safe, :attr_path, :if_extras, :unless_extras, :merge
+    OPTIONS = %i[
+      rewrite as if unless using with proc documentation format_with safe attr_path if_extras unless_extras merge expose_nil
     ].to_set.freeze
 
     # Merges the given options with current block options.
@@ -517,7 +537,7 @@ module Grape
       opts = {}
 
       merge_logic = proc do |key, existing_val, new_val|
-        if [:if, :unless].include?(key)
+        if %i[if unless].include?(key)
           if existing_val.is_a?(Hash) && new_val.is_a?(Hash)
             existing_val.merge(new_val)
           elsif new_val.is_a?(Hash)
@@ -543,7 +563,7 @@ module Grape
     #
     # @param options [Hash] Exposure options.
     def self.valid_options(options)
-      options.keys.each do |key|
+      options.each_key do |key|
         raise ArgumentError, "#{key.inspect} is not a valid option." unless OPTIONS.include?(key)
       end
 

data/lib/grape_entity/exposure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/exposure/base'
 require 'grape_entity/exposure/represent_exposure'
 require 'grape_entity/exposure/block_exposure'
@@ -10,67 +12,82 @@ require 'grape_entity/condition'
 module Grape
   class Entity
     module Exposure
-      def self.new(attribute, options)
-        conditions = compile_conditions(options)
-        base_args = [attribute, options, conditions]
-
-        if options[:proc]
-          block_exposure = BlockExposure.new(*base_args, &options[:proc])
-        else
-          delegator_exposure = DelegatorExposure.new(*base_args)
-        end
+      class << self
+        def new(attribute, options)
+          conditions = compile_conditions(attribute, options)
+          base_args = [attribute, options, conditions]
 
-        if options[:using]
+          passed_proc = options[:proc]
           using_class = options[:using]
+          format_with = options[:format_with]
 
-          if options[:proc]
-            RepresentExposure.new(*base_args, using_class, block_exposure)
+          if using_class
+            build_class_exposure(base_args, using_class, passed_proc)
+          elsif passed_proc
+            build_block_exposure(base_args, passed_proc)
+          elsif format_with
+            build_formatter_exposure(base_args, format_with)
+          elsif options[:nesting]
+            build_nesting_exposure(base_args)
           else
-            RepresentExposure.new(*base_args, using_class, delegator_exposure)
+            build_delegator_exposure(base_args)
           end
+        end
 
-        elsif options[:proc]
-          block_exposure
+        private
 
-        elsif options[:format_with]
-          format_with = options[:format_with]
+        def compile_conditions(attribute, options)
+          if_conditions = [
+            options[:if_extras],
+            options[:if]
+          ].compact.flatten.map { |cond| Condition.new_if(cond) }
 
-          if format_with.is_a? Symbol
-            FormatterExposure.new(*base_args, format_with)
-          elsif format_with.respond_to? :call
-            FormatterBlockExposure.new(*base_args, &format_with)
-          end
+          unless_conditions = [
+            options[:unless_extras],
+            options[:unless]
+          ].compact.flatten.map { |cond| Condition.new_unless(cond) }
 
-        elsif options[:nesting]
-          NestingExposure.new(*base_args)
+          unless_conditions << expose_nil_condition(attribute) if options[:expose_nil] == false
 
-        else
-          delegator_exposure
+          if_conditions + unless_conditions
         end
-      end
 
-      def self.compile_conditions(options)
-        if_conditions = []
-        unless options[:if_extras].nil?
-          if_conditions.concat(options[:if_extras])
+        def expose_nil_condition(attribute)
+          Condition.new_unless(
+            proc { |object, _options| Delegator.new(object).delegate(attribute).nil? }
+          )
         end
-        if_conditions << options[:if] unless options[:if].nil?
 
-        if_conditions.map! do |cond|
-          Condition.new_if cond
+        def build_class_exposure(base_args, using_class, passed_proc)
+          exposure =
+            if passed_proc
+              build_block_exposure(base_args, passed_proc)
+            else
+              build_delegator_exposure(base_args)
+            end
+
+          RepresentExposure.new(*base_args, using_class, exposure)
+        end
+
+        def build_formatter_exposure(base_args, format_with)
+          if format_with.is_a? Symbol
+            FormatterExposure.new(*base_args, format_with)
+          elsif format_with.respond_to?(:call)
+            FormatterBlockExposure.new(*base_args, &format_with)
+          end
         end
 
-        unless_conditions = []
-        unless options[:unless_extras].nil?
-          unless_conditions.concat(options[:unless_extras])
+        def build_nesting_exposure(base_args)
+          NestingExposure.new(*base_args)
         end
-        unless_conditions << options[:unless] unless options[:unless].nil?
 
-        unless_conditions.map! do |cond|
-          Condition.new_unless cond
+        def build_block_exposure(base_args, passed_proc)
+          BlockExposure.new(*base_args, &passed_proc)
         end
 
-        if_conditions + unless_conditions
+        def build_delegator_exposure(base_args)
+          DelegatorExposure.new(*base_args)
+        end
       end
     end
   end

data/lib/grape_entity/exposure/base.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Grape
   class Entity
     module Exposure
       class Base
-        attr_reader :attribute, :key, :is_safe, :documentation, :conditions, :for_merge
+        attr_reader :attribute, :is_safe, :documentation, :conditions, :for_merge
 
         def self.new(attribute, options, conditions, *args, &block)
           super(attribute, options, conditions).tap { |e| e.setup(*args, &block) }
@@ -11,7 +13,8 @@ module Grape
         def initialize(attribute, options, conditions)
           @attribute = attribute.try(:to_sym)
           @options = options
-          @key = (options[:as] || attribute).try(:to_sym)
+          key = options[:as] || attribute
+          @key = key.respond_to?(:to_sym) ? key.to_sym : key
           @is_safe = options[:safe]
           @for_merge = options[:merge]
           @attr_path_proc = options[:attr_path]
@@ -41,7 +44,7 @@ module Grape
         end
 
         # if we have any nesting exposures with the same name.
-        def deep_complex_nesting?
+        def deep_complex_nesting?(entity) # rubocop:disable Lint/UnusedMethodArgument
           false
         end
 
@@ -102,6 +105,10 @@ module Grape
           end
         end
 
+        def key(entity = nil)
+          @key.respond_to?(:call) ? entity.exec_with_object(@options, &@key) : @key
+        end
+
         def with_attr_path(entity, options)
           path_part = attr_path(entity, options)
           options.with_attr_path(path_part) do
@@ -109,6 +116,10 @@ module Grape
           end
         end
 
+        def replaceable_by?(other)
+          !nesting? && !conditional? && !other.nesting? && !other.conditional?
+        end
+
         protected
 
         attr_reader :options

data/lib/grape_entity/exposure/block_exposure.rb

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

data/lib/grape_entity/exposure/delegator_exposure.rb

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

data/lib/grape_entity/exposure/formatter_block_exposure.rb

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

data/lib/grape_entity/exposure/formatter_exposure.rb

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