Merge pull request #136 from bswinnerton/symbolize-only-and-except

Allow for strings in 'only' and 'except' options

Author: dblock

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#121](https://github.com/intridea/grape-entity/pull/122): Sublcassed Entity#documentation properly handles unexposed params - [@dan-corneanu](https://github.com/dan-corneanu).
 * [#134](https://github.com/intridea/grape-entity/pull/134): Subclasses no longer affected in all cases by `unexpose` in parent - [@etehtsea](https://github.com/etehtsea).
 * [#135](https://github.com/intridea/grape-entity/pull/135): Added `except` option - [@dan-corneanu](https://github.com/dan-corneanu).
+* [#136](https://github.com/intridea/grape-entity/pull/136): Allow for strings in `only` and `except` options - [@bswinnerton](https://github.com/bswinnerton).
 * Your contribution here.
 
 0.4.5 (2015-03-10)

lib/grape_entity/entity.rb

@@ -465,7 +465,7 @@ def only_fields(options, for_attribute = nil)
         else
           allowed_fields[attribute] = true
         end
-      end
+      end.symbolize_keys
 
       if for_attribute && @only_fields[for_attribute].is_a?(Array)
         @only_fields[for_attribute]
@@ -486,7 +486,7 @@ def except_fields(options, for_attribute = nil)
         else
           allowed_fields[attribute] = true
         end
-      end
+      end.symbolize_keys
 
       if for_attribute && @except_fields[for_attribute].is_a?(Array)
         @except_fields[for_attribute]

spec/grape_entity/entity_spec.rb

@@ -517,6 +517,48 @@ class Parent < Person
           expect(representation).to eq(name: nil)
         end
 
+        context 'with strings or symbols passed to only and except' do
+          let(:object) { OpenStruct.new(user: {}) }
+
+          before do
+            user_entity = Class.new(Grape::Entity)
+            user_entity.expose(:id, :name, :email)
+
+            subject.expose(:id, :name, :phone, :address)
+            subject.expose(:user, using: user_entity)
+          end
+
+          it 'can specify "only" option attributes as strings' do
+            representation = subject.represent(object, only: ['id', 'name', { 'user' => ['email'] }], serializable: true)
+            expect(representation).to eq(id: nil, name: nil, user: { email: nil })
+          end
+
+          it 'can specify "except" option attributes as strings' do
+            representation = subject.represent(object, except: ['id', 'name', { 'user' => ['email'] }], serializable: true)
+            expect(representation).to eq(phone: nil, address: nil, user: { id: nil, name: nil })
+          end
+
+          it 'can specify "only" option attributes as symbols' do
+            representation = subject.represent(object, only: [:name, :phone, { user: [:name] }], serializable: true)
+            expect(representation).to eq(name: nil, phone: nil, user: { name: nil })
+          end
+
+          it 'can specify "except" option attributes as symbols' do
+            representation = subject.represent(object, except: [:name, :phone, { user: [:name] }], serializable: true)
+            expect(representation).to eq(id: nil, address: nil, user: { id: nil, email: nil })
+          end
+
+          it 'can specify "only" attributes as strings and symbols' do
+            representation = subject.represent(object, only: [:id, 'address', { user: [:id, 'name'] }], serializable: true)
+            expect(representation).to eq(id: nil, address: nil, user: { id: nil, name: nil })
+          end
+
+          it 'can specify "except" attributes as strings and symbols' do
+            representation = subject.represent(object, except: [:id, 'address', { user: [:id, 'name'] }], serializable: true)
+            expect(representation).to eq(name: nil, phone: nil, user: { email: nil })
+          end
+        end
+
         it 'can specify children attributes with only' do
           user_entity = Class.new(Grape::Entity)
           user_entity.expose(:id, :name, :email)