grape-entity 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae09d2c2eb04cf66e6c186d175814bbd656d745c
-  data.tar.gz: cb06bd7e21f3b873631a59bcd736ff4c12f981af
+  metadata.gz: 6316984d3c73b100e20294679aa32bf4a9fccffd
+  data.tar.gz: 8f687c1d19b89540afb58a9a5c83b4b4a51e0fb1
 SHA512:
-  metadata.gz: bd4ec8cf775bf7e9ea5db80cb14ef4eec682aafb29610cf0581530f372a1929926ba8abb6e4f8e8aa9b8a5b97a0bc224548346a9e05158f75ae250d24eaa08f8
-  data.tar.gz: f626ea6a74c2bf15945a3c0a3c29b8609939227bcb228361eedeb9dd247fc33ab7d2df2bb7c768b1a2073cc640ddfd39db51b908ff1d6a73f4a64602b66260fa
+  metadata.gz: 0639798ea31a230451bc8480cf6bd97818d703d3b978c204d519237ef9accf2aff1834335d749a018a9f476c927355b5e804043680b2237aa11495cdead86bcf
+  data.tar.gz: daff836f74b47ad4b321b647387100bced7b484d734dfa7c2627f5b1d487b4307ed5cdbf4cd0c02018e2b3be3decea9d66d2dd8c08585c2f5bc1355e42aee71d

data/.travis.yml

@@ -6,14 +6,17 @@ cache: bundler
 
 rvm:
   - ruby-head
-  - 2.1.2
+  - 2.3.0
+  - 2.2
+  - 2.1
   - 2.0.0
   - 1.9.3
   - jruby-19mode
   - jruby-head
-  - rbx-2.2.10
+  - rbx-2
 
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx-2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.5.1 (2016-4-4)
+================
+
+* [#202](https://github.com/ruby-grape/grape-entity/pull/202): Fix: Reset `@using_class` memoization on `.setup` - [@rngtng](https://github.com/rngtng).
+* [#203](https://github.com/ruby-grape/grape-entity/pull/203): `Grape::Entity::Exposure::NestingExposure::NestedExposures.delete_if` always returns exposures - [@rngtng](https://github.com/rngtng).
+* [#204](https://github.com/ruby-grape/grape-entity/pull/204), [#138](https://github.com/ruby-grape/grape-entity/issues/138): Added ability to merge fields into hashes/root (`:merge` option for `.expose`) - [@avyy](https://github.com/avyy).
+
 0.5.0 (2015-12-07)
 ==================
 

data/README.md

@@ -21,9 +21,10 @@ module API
       expose :text, documentation: { type: "String", desc: "Status update text." }
       expose :ip, if: { type: :full }
       expose :user_type, :user_id, if: lambda { |status, options| status.user.public? }
+      expose :location, merge: true
       expose :contact_info do
         expose :phone
-        expose :address, using: API::Entities::Address
+        expose :address, merge: true, using: API::Entities::Address
       end
       expose :digest do |status, options|
         Digest::MD5.hexdigest status.txt
@@ -153,6 +154,40 @@ As example:
 
 ```
 
+#### Merge Fields
+
+Use `:merge` option to merge fields into the hash or into the root:
+
+```ruby
+expose :contact_info do
+  expose :phone
+  expose :address, merge: true, using: API::Entities::Address
+end
+
+expose :status, merge: true
+```
+
+This will return something like:
+
+```ruby
+{ contact_info: { phone: "88002000700", city: 'City 17', address_line: 'Block C' }, text: 'HL3', likes: 19 }
+```
+
+It also works with collections:
+
+```ruby
+expose :profiles do
+  expose :users, merge: true, using: API::Entities::User
+  expose :admins, merge: true, using: API::Entities::Admin
+end
+```
+
+Provide lambda to solve collisions:
+
+```ruby
+expose :status, merge: ->(key, old_val, new_val) { old_val + new_val if old_val && new_val }
+```
+
 #### Runtime Exposure
 
 Use a block or a `Proc` to evaluate exposure at runtime. The supplied block or

data/UPGRADING.md

@@ -0,0 +1,8 @@
+Upgrading Grape Entity
+===============
+
+### Upgrading to >= 0.5.1
+
+* `Grape::Entity::Exposure::NestingExposure::NestedExposures.delete_if` always
+returns exposures, regardless of delete result (used to be
+`nil` in negative case), see [#203](https://github.com/ruby-grape/grape-entity/pull/203).

data/lib/grape_entity/entity.rb

@@ -146,6 +146,7 @@ module Grape
     #   block to the expose call to achieve the same effect.
     # @option options :documentation Define documenation for an exposed
     #   field, typically the value is a hash with two fields, type and desc.
+    # @option options :merge This option allows you to merge an exposed field to the root
     def self.expose(*args, &block)
       options = merge_options(args.last.is_a?(Hash) ? args.pop : {})
 
@@ -498,7 +499,7 @@ module Grape
 
     # All supported options.
     OPTIONS = [
-      :rewrite, :as, :if, :unless, :using, :with, :proc, :documentation, :format_with, :safe, :attr_path, :if_extras, :unless_extras
+      :rewrite, :as, :if, :unless, :using, :with, :proc, :documentation, :format_with, :safe, :attr_path, :if_extras, :unless_extras, :merge
     ].to_set.freeze
 
     # Merges the given options with current block options.

data/lib/grape_entity/exposure/base.rb

@@ -2,7 +2,7 @@ module Grape
   class Entity
     module Exposure
       class Base
-        attr_reader :attribute, :key, :is_safe, :documentation, :conditions
+        attr_reader :attribute, :key, :is_safe, :documentation, :conditions, :for_merge
 
         def self.new(attribute, options, conditions, *args, &block)
           super(attribute, options, conditions).tap { |e| e.setup(*args, &block) }
@@ -13,6 +13,7 @@ module Grape
           @options = options
           @key = (options[:as] || attribute).try(:to_sym)
           @is_safe = options[:safe]
+          @for_merge = options[:merge]
           @attr_path_proc = options[:attr_path]
           @documentation = options[:documentation]
           @conditions = conditions

data/lib/grape_entity/exposure/nesting_exposure.rb

@@ -30,11 +30,12 @@ module Grape
 
         def value(entity, options)
           new_options = nesting_options_for(options)
+          output = OutputBuilder.new
 
-          normalized_exposures(entity, new_options).each_with_object({}) do |exposure, output|
+          normalized_exposures(entity, new_options).each_with_object(output) do |exposure, out|
             exposure.with_attr_path(entity, new_options) do
               result = exposure.value(entity, new_options)
-              output[exposure.key] = result
+              out.add(exposure, result)
             end
           end
         end
@@ -53,11 +54,12 @@ module Grape
 
         def serializable_value(entity, options)
           new_options = nesting_options_for(options)
+          output = OutputBuilder.new
 
-          normalized_exposures(entity, new_options).each_with_object({}) do |exposure, output|
+          normalized_exposures(entity, new_options).each_with_object(output) do |exposure, out|
             exposure.with_attr_path(entity, new_options) do
               result = exposure.serializable_value(entity, new_options)
-              output[exposure.key] = result
+              out.add(exposure, result)
             end
           end
         end
@@ -126,3 +128,4 @@ module Grape
 end
 
 require 'grape_entity/exposure/nesting_exposure/nested_exposures'
+require 'grape_entity/exposure/nesting_exposure/output_builder'

data/lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb

@@ -21,6 +21,7 @@ module Grape
           def delete_by(*attributes)
             reset_memoization!
             @exposures.reject! { |e| attributes.include? e.attribute }
+            @exposures
           end
 
           def clear

data/lib/grape_entity/exposure/nesting_exposure/output_builder.rb

@@ -0,0 +1,58 @@
+module Grape
+  class Entity
+    module Exposure
+      class NestingExposure
+        class OutputBuilder < SimpleDelegator
+          def initialize
+            @output_hash = {}
+            @output_collection = []
+          end
+
+          def add(exposure, result)
+            # Save a result array in collections' array if it should be merged
+            if result.is_a?(Array) && exposure.for_merge
+              @output_collection << result
+            else
+
+              # If we have an array which should not be merged - save it with a key as a hash
+              # If we have hash which should be merged - save it without a key (merge)
+              if exposure.for_merge
+                @output_hash.merge! result, &merge_strategy(exposure.for_merge)
+              else
+                @output_hash[exposure.key] = result
+              end
+
+            end
+          end
+
+          def __getobj__
+            output
+          end
+
+          private
+
+          # If output_collection contains at least one element we have to represent the output as a collection
+          def output
+            if @output_collection.empty?
+              output = @output_hash
+            else
+              output = @output_collection
+              output << @output_hash unless @output_hash.empty?
+              output.flatten!
+            end
+            output
+          end
+
+          # In case if we want to solve collisions providing lambda to :merge option
+          def merge_strategy(for_merge)
+            if for_merge.respond_to? :call
+              for_merge
+            else
+              -> {}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape_entity/exposure/represent_exposure.rb

@@ -5,6 +5,7 @@ module Grape
         attr_reader :using_class_name, :subexposure
 
         def setup(using_class_name, subexposure)
+          @using_class = nil
           @using_class_name = using_class_name
           @subexposure = subexposure
         end

data/lib/grape_entity/version.rb

@@ -1,3 +1,3 @@
 module GrapeEntity
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/grape_entity/entity_spec.rb

@@ -35,6 +35,23 @@ describe Grape::Entity do
         end
       end
 
+      context 'with a :merge option' do
+        let(:nested_hash) do
+          { something: { like_nested_hash: true }, special: { like_nested_hash: '12' } }
+        end
+
+        it 'merges an exposure to the root' do
+          subject.expose(:something, merge: true)
+          expect(subject.represent(nested_hash).serializable_hash).to eq(nested_hash[:something])
+        end
+
+        it 'allows to solve collisions providing a lambda to a :merge option' do
+          subject.expose(:something, merge: true)
+          subject.expose(:special, merge: ->(_, v1, v2) { v1 && v2 ? 'brand new val' : v2 })
+          expect(subject.represent(nested_hash).serializable_hash).to eq(like_nested_hash: 'brand new val')
+        end
+      end
+
       context 'with a block' do
         it 'errors out if called with multiple attributes' do
           expect { subject.expose(:name, :email) { true } }.to raise_error ArgumentError
@@ -243,6 +260,30 @@ describe Grape::Entity do
               }
             )
           end
+          it 'merges attriutes if :merge option is passed' do
+            user_entity = Class.new(Grape::Entity)
+            admin_entity = Class.new(Grape::Entity)
+            user_entity.expose(:id, :name)
+            admin_entity.expose(:id, :name)
+
+            subject.expose(:profiles) do
+              subject.expose(:users, merge: true, using: user_entity)
+              subject.expose(:admins, merge: true, using: admin_entity)
+            end
+
+            subject.expose :awesome do
+              subject.expose(:nested, merge: true) { |_| { just_a_key: 'value' } }
+              subject.expose(:another_nested, merge: true) { |_| { just_another_key: 'value' } }
+            end
+
+            additional_hash = { users: [{ id: 1, name: 'John' }, { id: 2, name: 'Jay' }],
+                                admins: [{ id: 3, name: 'Jack' }, { id: 4, name: 'James' }]
+                              }
+            expect(subject.represent(additional_hash).serializable_hash).to eq(
+              profiles: additional_hash[:users] + additional_hash[:admins],
+              awesome: { just_a_key: 'value', just_another_key: 'value' }
+            )
+          end
         end
       end
 
@@ -863,7 +904,7 @@ describe Grape::Entity do
         subject.expose :my_items
 
         representation = subject.represent(4.times.map { Object.new }, serializable: true)
-        expect(representation).to be_kind_of(Hash)
+        expect(representation).to be_kind_of(Grape::Entity::Exposure::NestingExposure::OutputBuilder)
         expect(representation).to have_key :my_items
         expect(representation[:my_items]).to be_kind_of Array
         expect(representation[:my_items].size).to be 4
@@ -1092,7 +1133,7 @@ describe Grape::Entity do
       context 'without safe option' do
         it 'throws an exception when an attribute is not found on the object' do
           fresh_class.expose :name, :nonexistent_attribute
-          expect { fresh_class.new(model).serializable_hash }.to raise_error
+          expect { fresh_class.new(model).serializable_hash }.to raise_error NoMethodError
         end
 
         it "exposes attributes that don't exist on the object only when they are generated by a block" do

data/spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
-  subject { described_class.new([]) }
+  subject(:nested_exposures) { described_class.new([]) }
 
   describe '#deep_complex_nesting?' do
     it 'is reset when additional exposure is added' do
@@ -31,4 +31,26 @@ describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
     end
   end
+
+  describe '.delete_by' do
+    subject { nested_exposures.delete_by(*attributes) }
+
+    let(:attributes) { [:id] }
+
+    before do
+      nested_exposures << Grape::Entity::Exposure.new(:id, {})
+    end
+
+    it 'deletes matching exposure' do
+      is_expected.to eq []
+    end
+
+    context "when given attribute doesn't exists" do
+      let(:attributes) { [:foo] }
+
+      it 'deletes matching exposure' do
+        is_expected.to eq(nested_exposures)
+      end
+    end
+  end
 end

data/spec/grape_entity/exposure/represent_exposure_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Grape::Entity::Exposure::RepresentExposure do
+  subject(:exposure) { described_class.new(:foo, {}, {}, double, double) }
+
+  describe '#setup' do
+    subject { exposure.setup(using_class_name, subexposure) }
+
+    let(:using_class_name) { double(:using_class_name) }
+    let(:subexposure)      { double(:subexposure) }
+
+    it 'sets using_class_name' do
+      expect { subject }.to change { exposure.using_class_name }.to(using_class_name)
+    end
+
+    it 'sets subexposure' do
+      expect { subject }.to change { exposure.subexposure }.to(subexposure)
+    end
+
+    context 'when using_class is set' do
+      before do
+        exposure.using_class
+      end
+
+      it 'resets using_class' do
+        expect { subject }.to change { exposure.using_class }
+      end
+    end
+  end
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: maruku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Extracted from Grape, A Ruby framework for rapid API development with
@@ -116,12 +116,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -130,6 +130,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - bench/serializing.rb
 - grape-entity.gemspec
 - lib/grape-entity.rb
@@ -154,11 +155,13 @@ files:
 - lib/grape_entity/exposure/formatter_exposure.rb
 - lib/grape_entity/exposure/nesting_exposure.rb
 - lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb
+- lib/grape_entity/exposure/nesting_exposure/output_builder.rb
 - lib/grape_entity/exposure/represent_exposure.rb
 - lib/grape_entity/options.rb
 - lib/grape_entity/version.rb
 - spec/grape_entity/entity_spec.rb
 - spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb
+- spec/grape_entity/exposure/represent_exposure_spec.rb
 - spec/grape_entity/exposure_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ruby-grape/grape-entity
@@ -171,23 +174,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: grape-entity
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
 test_files:
 - spec/grape_entity/entity_spec.rb
 - spec/grape_entity/exposure/nesting_exposure/nested_exposures_spec.rb
+- spec/grape_entity/exposure/represent_exposure_spec.rb
 - spec/grape_entity/exposure_spec.rb
 - spec/spec_helper.rb
 has_rdoc: