grape-entity 0.6.1 → 0.8.2

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

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
   subject(:nested_exposures) { described_class.new([]) }
 
-  describe '#deep_complex_nesting?' do
+  describe '#deep_complex_nesting?(entity)' do
     it 'is reset when additional exposure is added' do
       subject << Grape::Entity::Exposure.new(:x, {})
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
-      subject.deep_complex_nesting?
+      subject.deep_complex_nesting?(subject)
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to_not be_nil
       subject << Grape::Entity::Exposure.new(:y, {})
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
@@ -16,7 +18,7 @@ describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
     it 'is reset when exposure is deleted' do
       subject << Grape::Entity::Exposure.new(:x, {})
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
-      subject.deep_complex_nesting?
+      subject.deep_complex_nesting?(subject)
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to_not be_nil
       subject.delete_by(:x)
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
@@ -25,7 +27,7 @@ describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
     it 'is reset when exposures are cleared' do
       subject << Grape::Entity::Exposure.new(:x, {})
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil
-      subject.deep_complex_nesting?
+      subject.deep_complex_nesting?(subject)
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to_not be_nil
       subject.clear
       expect(subject.instance_variable_get(:@deep_complex_nesting)).to be_nil

data/spec/grape_entity/exposure/represent_exposure_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Entity::Exposure::RepresentExposure do
@@ -10,11 +12,11 @@ describe Grape::Entity::Exposure::RepresentExposure do
     let(:subexposure)      { double(:subexposure) }
 
     it 'sets using_class_name' do
-      expect { subject }.to change { exposure.using_class_name }.to(using_class_name)
+      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)
+      expect { subject }.to change(exposure, :subexposure).to(subexposure)
     end
 
     context 'when using_class is set' do
@@ -23,7 +25,7 @@ describe Grape::Entity::Exposure::RepresentExposure do
       end
 
       it 'resets using_class' do
-        expect { subject }.to change { exposure.using_class }
+        expect { subject }.to change(exposure, :using_class)
       end
     end
   end

data/spec/grape_entity/exposure_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Entity::Exposure do
@@ -24,12 +26,22 @@ describe Grape::Entity::Exposure do
   describe '#key' do
     it 'returns the attribute if no :as is set' do
       fresh_class.expose :name
-      expect(subject.key).to eq :name
+      expect(subject.key(entity)).to eq :name
     end
 
     it 'returns the :as alias if one exists' do
       fresh_class.expose :name, as: :nombre
-      expect(subject.key).to eq :nombre
+      expect(subject.key(entity)).to eq :nombre
+    end
+
+    it 'returns the result if :as is a proc' do
+      fresh_class.expose :name, as: proc { object.name.reverse }
+      expect(subject.key(entity)).to eq(model.name.reverse)
+    end
+
+    it 'returns the result if :as is a lambda' do
+      fresh_class.expose :name, as: ->(obj, _opts) { obj.name.reverse }
+      expect(subject.key(entity)).to eq(model.name.reverse)
     end
   end
 

data/spec/grape_entity/hash_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 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
@@ -10,6 +12,14 @@ describe Grape::Entity do
         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
@@ -17,6 +27,15 @@ describe Grape::Entity do
           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 = {
@@ -31,6 +50,24 @@ describe Grape::Entity do
       }
     }
 
+    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))
 

data/spec/grape_entity/options_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Entity::Options do
+  module EntitySpec
+    class Crystalline
+      attr_accessor :prop1, :prop2, :prop3
+
+      def initialize
+        @prop1 = 'value1'
+        @prop2 = 'value2'
+        @prop3 = 'value3'
+      end
+    end
+
+    class CrystallineEntity < Grape::Entity
+      expose :prop1, if: ->(_, options) { options.fetch(:signal) }
+      expose :prop2, if: ->(_, options) { options.fetch(:beam, 'destructive') == 'destructive' }
+    end
+  end
+
+  context '#fetch' do
+    it 'without passing in a required option raises KeyError' do
+      expect { EntitySpec::CrystallineEntity.represent(EntitySpec::Crystalline.new).as_json }.to raise_error KeyError
+    end
+
+    it 'passing in a required option will expose the values' do
+      crystalline_entity = EntitySpec::CrystallineEntity.represent(EntitySpec::Crystalline.new, signal: true)
+      expect(crystalline_entity.as_json).to eq(prop1: 'value1', prop2: 'value2')
+    end
+
+    it 'with an option that is not default will not expose that value' do
+      crystalline_entity = EntitySpec::CrystallineEntity.represent(EntitySpec::Crystalline.new, signal: true, beam: 'intermittent')
+      expect(crystalline_entity.as_json).to eq(prop1: 'value1')
+    end
+  end
+
+  context '#dig', skip: !{}.respond_to?(:dig) do
+    let(:model_class) do
+      Class.new do
+        attr_accessor :prop1
+
+        def initialize
+          @prop1 = 'value1'
+        end
+      end
+    end
+
+    let(:entity_class) do
+      Class.new(Grape::Entity) do
+        expose :prop1, if: ->(_, options) { options.dig(:first, :second) == :nested }
+      end
+    end
+
+    it 'without passing in a expected option hide the value' do
+      entity = entity_class.represent(model_class.new, first: { invalid: :nested })
+      expect(entity.as_json).to eq({})
+    end
+
+    it 'passing in a expected option will expose the values' do
+      entity = entity_class.represent(model_class.new, first: { second: :nested })
+      expect(entity.as_json).to eq(prop1: 'value1')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,20 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'coveralls'
+
+# This works around the hash extensions not being automatically included in ActiveSupport < 4
+require 'active_support/version'
+require 'active_support/core_ext/hash' if ActiveSupport::VERSION &&
+                                          ActiveSupport::VERSION::MAJOR &&
+                                          ActiveSupport::VERSION::MAJOR < 4
+
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+Coveralls.wear! unless RUBY_PLATFORM.eql? 'java'
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,35 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.40'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.40'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: maruku
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -172,6 +158,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -203,6 +190,7 @@ files:
 - lib/grape_entity/delegator/hash_object.rb
 - lib/grape_entity/delegator/openstruct_object.rb
 - lib/grape_entity/delegator/plain_object.rb
+- lib/grape_entity/deprecated.rb
 - lib/grape_entity/entity.rb
 - lib/grape_entity/exposure.rb
 - lib/grape_entity/exposure/base.rb
@@ -221,12 +209,13 @@ files:
 - spec/grape_entity/exposure/represent_exposure_spec.rb
 - spec/grape_entity/exposure_spec.rb
 - spec/grape_entity/hash_spec.rb
+- spec/grape_entity/options_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ruby-grape/grape-entity
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,16 +223,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.6
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: grape-entity
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.0.rc.1
+signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
 test_files:
@@ -252,4 +240,5 @@ test_files:
 - spec/grape_entity/exposure/represent_exposure_spec.rb
 - spec/grape_entity/exposure_spec.rb
 - spec/grape_entity/hash_spec.rb
+- spec/grape_entity/options_spec.rb
 - spec/spec_helper.rb