Support hashes with string keys (#319)

* Support hashes with string keys

Before this change the only way I could find to access a hash with string keys
was to either convert it to a symbol hash or define methods in the entity.

This should at least allow the entire hash to be accessed with string keys yet default to existing behaviour (symbol keys).

* Fix changelog entries

Author: mhenrixon

.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Metrics/AbcSize:

CHANGELOG.md

@@ -3,18 +3,19 @@
 #### Features
 
 * Your contribution here.
+* [#319](https://github.com/ruby-grape/grape-entity/pull/319): Support hashes with string keys - [@mhenrixon](https://github.com/mhenrixon).
 * [#300](https://github.com/ruby-grape/grape-entity/pull/300): Loosens activesupport to 3 - [@ericschultz](https://github.com/ericschultz).
 
 #### Fixes
 
 * Your contribution here.
-* [#258](https://github.com/ruby-grape/grape-entity/pull/307): Allow exposures to call methods defined in modules included in an entity [@robertoz-01](https://github.com/robertoz-01).
+* [#307](https://github.com/ruby-grape/grape-entity/pull/307): Allow exposures to call methods defined in modules included in an entity [@robertoz-01](https://github.com/robertoz-01).
 
 ### 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).
+* [#297](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)
 

lib/grape_entity/delegator/fetchable_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class FetchableObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.fetch attribute
         end
       end

lib/grape_entity/delegator/hash_object.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'pry'
+
 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

lib/grape_entity/delegator/openstruct_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class OpenStructObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.send attribute
         end
       end

lib/grape_entity/delegator/plain_object.rb

@@ -4,7 +4,7 @@ module Grape
   class Entity
     module Delegator
       class PlainObject < Base
-        def delegate(attribute)
+        def delegate(attribute, **)
           object.send attribute
         end
 

lib/grape_entity/entity.rb

@@ -114,6 +114,22 @@ def formatters
       end
 
       attr_writer :formatters
+
+      def hash_access
+        @hash_access ||= :to_sym
+      end
+
+      def hash_access=(value)
+        @hash_access =
+          case value
+          when :to_s, :str, :string
+            :to_s
+          when :to_sym, :sym, :symbol
+            :to_sym
+          else
+            :to_sym
+          end
+      end
     end
 
     @formatters = {}
@@ -459,8 +475,8 @@ def inspect
 
     def initialize(object, options = {})
       @object = object
-      @delegator = Delegator.new(object)
       @options = options.is_a?(Options) ? options : Options.new(options)
+      @delegator = Delegator.new(object)
     end
 
     def root_exposures
@@ -514,7 +530,7 @@ def delegate_attribute(attribute)
       if is_defined_in_entity?(attribute)
         send(attribute)
       else
-        delegator.delegate(attribute)
+        delegator.delegate(attribute, hash_access: self.class.hash_access)
       end
     end
 

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,13 +12,30 @@ class Address < Grape::Entity
         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
         expose :address do |c, o|
           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 @@ class Company < Grape::Entity
       }
     }
 
+    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))