grape-entity 0.4.8 → 0.10.2

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Entity::Exposure::NestingExposure::NestedExposures do
+  subject(:nested_exposures) { described_class.new([]) }
+
+  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)
+      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
+    end
+
+    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)
+      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
+    end
+
+    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)
+      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
+    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,32 @@
+# frozen_string_literal: true
+
+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

data/spec/grape_entity/exposure_spec.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Entity::Exposure do
+  let(:fresh_class) { Class.new(Grape::Entity) }
+  let(:model) { double(attributes) }
+  let(:attributes) do
+    {
+      name: 'Bob Bobson',
+      email: 'bob@example.com',
+      birthday: Time.gm(2012, 2, 27),
+      fantasies: ['Unicorns', 'Double Rainbows', 'Nessy'],
+      characteristics: [
+        { key: 'hair_color', value: 'brown' }
+      ],
+      friends: [
+        double(name: 'Friend 1', email: 'friend1@example.com', characteristics: [], fantasies: [], birthday: Time.gm(2012, 2, 27), friends: []),
+        double(name: 'Friend 2', email: 'friend2@example.com', characteristics: [], fantasies: [], birthday: Time.gm(2012, 2, 27), friends: [])
+      ]
+    }
+  end
+  let(:entity) { fresh_class.new(model) }
+  subject { fresh_class.find_exposure(:name) }
+
+  describe '#key' do
+    it 'returns the attribute if no :as is set' do
+      fresh_class.expose :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(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
+
+  describe '#conditions_met?' do
+    it 'only passes through hash :if exposure if all attributes match' do
+      fresh_class.expose :name, if: { condition1: true, condition2: true }
+
+      expect(subject.conditions_met?(entity, {})).to be false
+      expect(subject.conditions_met?(entity, condition1: true)).to be false
+      expect(subject.conditions_met?(entity, condition1: true, condition2: true)).to be true
+      expect(subject.conditions_met?(entity, condition1: false, condition2: true)).to be false
+      expect(subject.conditions_met?(entity, condition1: true, condition2: true, other: true)).to be true
+    end
+
+    it 'looks for presence/truthiness if a symbol is passed' do
+      fresh_class.expose :name, if: :condition1
+
+      expect(subject.conditions_met?(entity, {})).to be false
+      expect(subject.conditions_met?(entity, condition1: true)).to be true
+      expect(subject.conditions_met?(entity, condition1: false)).to be false
+      expect(subject.conditions_met?(entity, condition1: nil)).to be false
+    end
+
+    it 'looks for absence/falsiness if a symbol is passed' do
+      fresh_class.expose :name, unless: :condition1
+
+      expect(subject.conditions_met?(entity, {})).to be true
+      expect(subject.conditions_met?(entity, condition1: true)).to be false
+      expect(subject.conditions_met?(entity, condition1: false)).to be true
+      expect(subject.conditions_met?(entity, condition1: nil)).to be true
+    end
+
+    it 'only passes through proc :if exposure if it returns truthy value' do
+      fresh_class.expose :name, if: ->(_, opts) { opts[:true] }
+
+      expect(subject.conditions_met?(entity, true: false)).to be false
+      expect(subject.conditions_met?(entity, true: true)).to be true
+    end
+
+    it 'only passes through hash :unless exposure if any attributes do not match' do
+      fresh_class.expose :name, unless: { condition1: true, condition2: true }
+
+      expect(subject.conditions_met?(entity, {})).to be true
+      expect(subject.conditions_met?(entity, condition1: true)).to be true
+      expect(subject.conditions_met?(entity, condition1: true, condition2: true)).to be false
+      expect(subject.conditions_met?(entity, condition1: false, condition2: true)).to be true
+      expect(subject.conditions_met?(entity, condition1: true, condition2: true, other: true)).to be false
+      expect(subject.conditions_met?(entity, condition1: false, condition2: false)).to be true
+    end
+
+    it 'only passes through proc :unless exposure if it returns falsy value' do
+      fresh_class.expose :name, unless: ->(_, opts) { opts[:true] == true }
+
+      expect(subject.conditions_met?(entity, true: false)).to be true
+      expect(subject.conditions_met?(entity, true: true)).to be false
+    end
+  end
+end

data/spec/grape_entity/hash_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Entity do
+  it 'except option for nested entity', :aggregate_failures do
+    module EntitySpec
+      class Address < Grape::Entity
+        expose :post, if: :full
+        expose :city
+        expose :street
+        expose :house
+      end
+
+      class AddressWithString < Grape::Entity
+        self.hash_access = :string
+        expose :post, if: :full
+        expose :city
+        expose :street
+        expose :house, expose_nil: false
+      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 = {
+      full_name: 'full_name',
+      name: 'name',
+      address: {
+        post: '123456',
+        city: 'city',
+        street: 'street',
+        house: 'house',
+        something_else: 'something_else'
+      }
+    }
+
+    company_with_string = {
+      'full_name' => 'full_name',
+      'name' => 'name',
+      'address' => {
+        'post' => '123456',
+        'city' => 'city',
+        'street' => 'street',
+        'house' => 'house',
+        'something_else' => 'something_else'
+      }
+    }
+
+    company_without_house_with_string = {
+      'full_name' => 'full_name',
+      'name' => 'name',
+      'address' => {
+        'post' => '123456',
+        'city' => 'city',
+        'street' => 'street',
+        '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_without_house_with_string).serializable_hash).to eq \
+      company.slice(:name).merge(address: company[:address].slice(:city, :street))
+
+    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))
+
+    expect(EntitySpec::Company.represent(company, full: true).serializable_hash).to eq \
+      company.slice(:full_name, :name).merge(address: company[:address].slice(:city, :street, :house))
+  end
+end

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,24 @@
+# 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
+
+# Skip code covarge on Ruby >= 3.1
+# See https://github.com/simplecov-ruby/simplecov/issues/1003
+unless RUBY_VERSION >= '3.1'
+  SimpleCov.start do
+    add_filter 'spec/'
+  end
+
+  Coveralls.wear! unless RUBY_PLATFORM.eql? 'java'
+end
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
@@ -7,6 +28,4 @@ require 'bundler'
 
 Bundler.require :default, :test
 
-require 'pry'
-
 RSpec.configure(&:raise_errors_for_deprecations!)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.10.2
 platform: ruby
 authors:
 - Michael Bleigh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: pry
+  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: pry-byebug
+  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: rack-test
+  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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,16 +128,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,39 +158,65 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - bench/serializing.rb
 - grape-entity.gemspec
 - lib/grape-entity.rb
 - lib/grape_entity.rb
+- lib/grape_entity/condition.rb
+- lib/grape_entity/condition/base.rb
+- lib/grape_entity/condition/block_condition.rb
+- lib/grape_entity/condition/hash_condition.rb
+- lib/grape_entity/condition/symbol_condition.rb
 - lib/grape_entity/delegator.rb
 - lib/grape_entity/delegator/base.rb
 - lib/grape_entity/delegator/fetchable_object.rb
 - 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
+- lib/grape_entity/exposure/block_exposure.rb
+- lib/grape_entity/exposure/delegator_exposure.rb
+- lib/grape_entity/exposure/formatter_block_exposure.rb
+- 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/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
@@ -156,17 +224,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: grape-entity
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.
-test_files: []
-has_rdoc: 
+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/grape_entity/hash_spec.rb
+- spec/grape_entity/options_spec.rb
+- spec/spec_helper.rb

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-
-language: ruby
-
-cache: bundler
-
-rvm:
-  - ruby-head
-  - 2.1.2
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-  - jruby-head
-  - rbx-2.2.10
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head