rspec-grape-entity 0.1.0

data/spec/entities/test_entity_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe TestEntity, type: :grape_entity do
+  let(:object) do
+    OpenStruct.new id: 1,
+                   record_status: "active",
+                   user: OpenStruct.new,
+                   read: true,
+                   update: false,
+                   destroy: false,
+                   created_at: Time.utc(2022, 1, 1, 15, 0, 0),
+                   updated_at: Time.now,
+                   has_date: true
+  end
+
+  it { expect(described_class).to have_root("test_items").with_singular("test_item") }
+
+  context "when using its_exposure" do
+    let(:object_without_date) { OpenStruct.new has_date: false }
+
+    its_exposure(:id) { is_expected.to be_a_delegator_exposure }
+    its_exposure(:id) { is_expected.to include_documentation type: Integer, desc: "The record id" }
+    its_exposure(:id) { is_expected.not_to be_safe }
+    its_exposure(:id) { is_expected.not_to be_merged }
+    its_exposure(:id) { is_expected.not_to override_exposure }
+    its_exposure(:record_status) { is_expected.to be_a_delegator_exposure }
+    its_exposure(:record_status) { is_expected.to have_key :status }
+    its_exposure(:record_status) { is_expected.to have_conditions_met(object).with_options(all: :something) }
+    its_exposure(:record_status) { is_expected.to_not have_conditions_met object }
+    its_exposure(:record_status) { is_expected.not_to be_safe }
+    its_exposure(:record_status) { is_expected.not_to be_merged }
+    its_exposure(:record_status) { is_expected.not_to override_exposure }
+    its_exposure(:user) { is_expected.to be_a_represent_exposure }
+    its_exposure(:user) { is_expected.to be_using_class UserEntity }
+    its_exposure(:user) { is_expected.to have_conditions_met(object).with_options(type: :admin) }
+    its_exposure(:user) { is_expected.not_to have_conditions_met(object).with_options(type: :user) }
+    its_exposure(:user) { is_expected.not_to have_conditions_met object }
+    its_exposure(:custom_data) { is_expected.to be_a_block_exposure }
+    its_exposure(:custom_data) { is_expected.not_to be_safe }
+    its_exposure(:custom_data) { is_expected.to be_merged }
+    its_exposure(:custom_data) { is_expected.not_to override_exposure }
+    its_exposure(:permissions) { is_expected.to be_a_nesting_exposure }
+    its_exposure(:permissions) { is_expected.not_to be_safe }
+    its_exposure(:permissions) { is_expected.not_to be_merged }
+    its_exposure(:permissions) { is_expected.to override_exposure }
+    its_exposure("permissions.read") { is_expected.to be_a_delegator_exposure }
+    its_exposure("permissions.read") { is_expected.not_to be_safe }
+    its_exposure("permissions.read") { is_expected.not_to be_merged }
+    its_exposure("permissions.read") { is_expected.not_to override_exposure }
+    its_exposure("permissions.update") { is_expected.to be_a_delegator_exposure }
+    its_exposure("permissions.update") { is_expected.not_to be_safe }
+    its_exposure("permissions.update") { is_expected.not_to be_merged }
+    its_exposure("permissions.update") { is_expected.not_to override_exposure }
+    its_exposure("permissions.destroy") { is_expected.to be_a_delegator_exposure }
+    its_exposure("permissions.destroy") { is_expected.not_to be_safe }
+    its_exposure("permissions.destroy") { is_expected.not_to be_merged }
+    its_exposure("permissions.destroy") { is_expected.not_to override_exposure }
+    its_exposure("created_at") { is_expected.to be_a_formatter_block_exposure }
+    its_exposure("created_at") { is_expected.to have_formatting("2022-01-01T15:00:00Z").with_object(object) }
+    its_exposure("created_at") { is_expected.not_to be_safe }
+    its_exposure("created_at") { is_expected.not_to be_merged }
+    its_exposure("created_at") { is_expected.not_to override_exposure }
+    its_exposure("created_at") { is_expected.to have_conditions_met object }
+    its_exposure("created_at") { is_expected.to_not have_conditions_met object_without_date }
+  end
+
+  context "when using describe_exposure" do
+    shared_examples "has permissions" do |permission|
+      describe_exposure "permissions.#{permission}" do
+        it { is_expected.to be_a_delegator_exposure }
+        it { is_expected.not_to be_safe }
+        it { is_expected.not_to be_merged }
+        it { is_expected.not_to override_exposure }
+      end
+    end
+
+    describe_exposure :id do
+      it { is_expected.to be_a_delegator_exposure }
+      it { is_expected.to include_documentation type: Integer, desc: "The record id" }
+      it { is_expected.not_to be_safe }
+      it { is_expected.not_to be_merged }
+      it { is_expected.not_to override_exposure }
+    end
+
+    describe_exposure :record_status do
+      it { is_expected.to be_a_delegator_exposure }
+      it { is_expected.to have_key :status }
+      it { is_expected.to have_conditions_met(object).with_options(all: :something) }
+      it { is_expected.to_not have_conditions_met object }
+      it { is_expected.not_to be_safe }
+      it { is_expected.not_to be_merged }
+      it { is_expected.not_to override_exposure }
+    end
+
+    describe_exposure :user do
+      it { is_expected.to be_a_represent_exposure }
+      it { is_expected.to be_using_class UserEntity }
+
+      context "when type is an admin" do
+        it { is_expected.to have_conditions_met(object).with_options(type: :admin) }
+      end
+
+      context "when type is not an admin" do
+        it { is_expected.not_to have_conditions_met(object).with_options(type: :user) }
+      end
+
+      context "when no type is declared" do
+        it { is_expected.not_to have_conditions_met object }
+      end
+    end
+
+    describe_exposure :custom_data do
+      it { is_expected.to be_a_block_exposure }
+      it { is_expected.not_to be_safe }
+      it { is_expected.to be_merged }
+      it { is_expected.not_to override_exposure }
+    end
+
+    describe_exposure :permissions do
+      it { is_expected.to be_a_nesting_exposure }
+      it { is_expected.not_to be_safe }
+      it { is_expected.not_to be_merged }
+      it { is_expected.to override_exposure }
+    end
+
+    it_behaves_like "has permissions", "read"
+    it_behaves_like "has permissions", "update"
+    it_behaves_like "has permissions", "destroy"
+
+    describe_exposure :created_at do
+      it { is_expected.to be_a_formatter_block_exposure }
+      it { is_expected.to have_formatting("2022-01-01T15:00:00Z").with_object(object) }
+      it { is_expected.not_to be_safe }
+      it { is_expected.not_to be_merged }
+      it { is_expected.not_to override_exposure }
+
+      context "when has date" do
+        it { is_expected.to have_conditions_met object }
+      end
+
+      context "when does not have date" do
+        let(:object) { OpenStruct.new has_date: false }
+
+        it { is_expected.not_to have_conditions_met object }
+      end
+    end
+  end
+end

data/spec/its_exposure_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::ItsExposure do
+  include RSpec::Grape::Entity::DSL
+
+  let(:entity) { TestEntity }
+
+  its_exposure(:id)
+  its_exposure("id")
+  its_exposure(:id) { is_expected.to be_a Grape::Entity::Exposure::DelegatorExposure }
+  its_exposure(:unknown) { is_expected.to be_nil }
+  its_exposure("permissions.read") { is_expected.to be_a Grape::Entity::Exposure::DelegatorExposure }
+  its_exposure("unknown.unknown") { expect { __attribute_exposure }.to raise_error NoMethodError }
+end

data/spec/matchers/be_a_exposure_type_matcher_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::BeAExposureTypeMatcher do
+  include RSpec::Grape::Entity::Matchers::BeAExposureTypeMatcher
+
+  let(:entity) { TestEntity }
+  subject(:exposure) { entity.find_exposure attribute }
+
+  context "when a block exposure" do
+    let(:attribute) { :custom_data }
+    it { is_expected.to be_a_exposure_type :block }
+    it { is_expected.not_to be_a_exposure_type :delegator }
+    it { is_expected.not_to be_a_exposure_type :formatter }
+    it { is_expected.not_to be_a_exposure_type :formatter_block }
+    it { is_expected.not_to be_a_exposure_type :nesting }
+    it { is_expected.not_to be_a_exposure_type :represent }
+    it { is_expected.to be_a_block_exposure }
+    it { is_expected.not_to be_a_delegator_exposure }
+    it { is_expected.not_to be_a_formatter_exposure }
+    it { is_expected.not_to be_a_formatter_block_exposure }
+    it { is_expected.not_to be_a_nesting_exposure }
+    it { is_expected.not_to be_a_represent_exposure }
+  end
+
+  context "when a delegator exposure" do
+    let(:attribute) { :id }
+    it { is_expected.not_to be_a_exposure_type :block }
+    it { is_expected.to be_a_exposure_type :delegator }
+    it { is_expected.not_to be_a_exposure_type :formatter }
+    it { is_expected.not_to be_a_exposure_type :formatter_block }
+    it { is_expected.not_to be_a_exposure_type :nesting }
+    it { is_expected.not_to be_a_exposure_type :represent }
+    it { is_expected.not_to be_a_block_exposure }
+    it { is_expected.to be_a_delegator_exposure }
+    it { is_expected.not_to be_a_formatter_exposure }
+    it { is_expected.not_to be_a_formatter_block_exposure }
+    it { is_expected.not_to be_a_nesting_exposure }
+    it { is_expected.not_to be_a_represent_exposure }
+  end
+
+  context "when a formatter exposure" do
+    let(:attribute) { :updated_at }
+    it { is_expected.not_to be_a_exposure_type :block }
+    it { is_expected.not_to be_a_exposure_type :delegator }
+    it { is_expected.to be_a_exposure_type :formatter }
+    it { is_expected.not_to be_a_exposure_type :formatter_block }
+    it { is_expected.not_to be_a_exposure_type :nesting }
+    it { is_expected.not_to be_a_exposure_type :represent }
+    it { is_expected.not_to be_a_block_exposure }
+    it { is_expected.not_to be_a_delegator_exposure }
+    it { is_expected.to be_a_formatter_exposure }
+    it { is_expected.not_to be_a_formatter_block_exposure }
+    it { is_expected.not_to be_a_nesting_exposure }
+    it { is_expected.not_to be_a_represent_exposure }
+  end
+
+  context "when a formatter block exposure" do
+    let(:attribute) { :created_at }
+    it { is_expected.not_to be_a_exposure_type :block }
+    it { is_expected.not_to be_a_exposure_type :delegator }
+    it { is_expected.not_to be_a_exposure_type :formatter }
+    it { is_expected.to be_a_exposure_type :formatter_block }
+    it { is_expected.not_to be_a_exposure_type :nesting }
+    it { is_expected.not_to be_a_exposure_type :represent }
+    it { is_expected.not_to be_a_block_exposure }
+    it { is_expected.not_to be_a_delegator_exposure }
+    it { is_expected.not_to be_a_formatter_exposure }
+    it { is_expected.to be_a_formatter_block_exposure }
+    it { is_expected.not_to be_a_nesting_exposure }
+    it { is_expected.not_to be_a_represent_exposure }
+  end
+
+  context "when a nesting exposure" do
+    let(:attribute) { :permissions }
+    it { is_expected.not_to be_a_exposure_type :block }
+    it { is_expected.not_to be_a_exposure_type :delegator }
+    it { is_expected.not_to be_a_exposure_type :formatter }
+    it { is_expected.not_to be_a_exposure_type :formatter_block }
+    it { is_expected.to be_a_exposure_type :nesting }
+    it { is_expected.not_to be_a_exposure_type :represent }
+    it { is_expected.not_to be_a_block_exposure }
+    it { is_expected.not_to be_a_delegator_exposure }
+    it { is_expected.not_to be_a_formatter_exposure }
+    it { is_expected.not_to be_a_formatter_block_exposure }
+    it { is_expected.to be_a_nesting_exposure }
+    it { is_expected.not_to be_a_represent_exposure }
+  end
+
+  context "when a represent exposure" do
+    let(:attribute) { :user }
+    it { is_expected.not_to be_a_exposure_type :block }
+    it { is_expected.not_to be_a_exposure_type :delegator }
+    it { is_expected.not_to be_a_exposure_type :formatter }
+    it { is_expected.not_to be_a_exposure_type :formatter_block }
+    it { is_expected.not_to be_a_exposure_type :nesting }
+    it { is_expected.to be_a_exposure_type :represent }
+    it { is_expected.not_to be_a_block_exposure }
+    it { is_expected.not_to be_a_delegator_exposure }
+    it { is_expected.not_to be_a_formatter_exposure }
+    it { is_expected.not_to be_a_formatter_block_exposure }
+    it { is_expected.not_to be_a_nesting_exposure }
+    it { is_expected.to be_a_represent_exposure }
+  end
+end

data/spec/matchers/be_merged_matcher_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::BeMergedMatcher do
+  include RSpec::Grape::Entity::Matchers::BeMergedMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when merged" do
+    subject(:exposure) { entity.find_exposure :custom_data }
+    it { is_expected.to be_merged }
+  end
+
+  context "when not merged" do
+    subject(:exposure) { entity.find_exposure :id }
+    it { is_expected.not_to be_merged }
+  end
+end

data/spec/matchers/be_safe_matcher_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::BeSafeMatcher do
+  include RSpec::Grape::Entity::Matchers::BeSafeMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when safe" do
+    subject(:exposure) { entity.find_exposure :user }
+    it { is_expected.to be_safe }
+  end
+
+  context "when not safe" do
+    subject(:exposure) { entity.find_exposure :id }
+    it { is_expected.not_to be_safe }
+  end
+end

data/spec/matchers/be_using_class_matcher_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::BeUsingClassMatcher do
+  include RSpec::Grape::Entity::Matchers::BeUsingClassMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when using a represent entity" do
+    subject(:exposure) { entity.find_exposure :user }
+    it { is_expected.to be_using_class UserEntity }
+    it { is_expected.not_to be_using_class TestEntity }
+  end
+end

data/spec/matchers/have_conditions_met_matcher_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::HaveConditionsMetMatcher do
+  include RSpec::Grape::Entity::Matchers::HaveConditionsMetMatcher
+
+  let(:entity) { TestEntity }
+  let(:object) { OpenStruct.new has_date: true }
+
+  context "when condition a symbol" do
+    subject(:exposure) { entity.find_exposure :record_status }
+
+    it { is_expected.to have_conditions_met(object).with_options(all: true) }
+    it { is_expected.to_not have_conditions_met(object) }
+  end
+
+  context "when condition a hash" do
+    subject(:exposure) { entity.find_exposure :user }
+
+    it { is_expected.to have_conditions_met(object).with_options(type: :admin) }
+    it { is_expected.to_not have_conditions_met(object).with_options(type: :user) }
+    it { is_expected.to_not have_conditions_met(object) }
+  end
+
+  context "when condition a proc" do
+    subject(:exposure) { entity.find_exposure :created_at }
+
+    let(:false_object) { OpenStruct.new date: false }
+
+    it { is_expected.to have_conditions_met(object) }
+    it { is_expected.not_to have_conditions_met(false_object) }
+  end
+
+  context "when no conditions defined" do
+    subject(:exposure) { entity.find_exposure :id }
+
+    it { is_expected.to have_conditions_met(object) }
+  end
+end

data/spec/matchers/have_formatting_matcher_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::HaveFormattingMatcher do
+  include RSpec::Grape::Entity::Matchers::HaveFormattingMatcher
+
+  let(:entity) { TestEntity }
+  let(:object) do
+    OpenStruct.new created_at: Time.utc(2022, 1, 22, 17, 0, 0),
+                   updated_at: Time.utc(2022, 2, 4, 6, 0, 0)
+  end
+
+  context "when formatter is a symbol" do
+    subject(:exposure) { entity.find_exposure :updated_at }
+
+    it { is_expected.to have_formatting :iso_timestamp }
+  end
+
+  context "when formatter is a block" do
+    subject(:exposure) { entity.find_exposure :created_at }
+
+    it { is_expected.to have_formatting("2022-01-22T17:00:00Z").with_object(object) }
+  end
+end

data/spec/matchers/have_key_matcher_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::HaveKeyMatcher do
+  include RSpec::Grape::Entity::Matchers::HaveKeyMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when alias is not defined" do
+    subject(:exposure) { entity.find_exposure :id }
+
+    it { is_expected.to have_key :id }
+    it { is_expected.not_to have_key :external_id }
+  end
+
+  context "when alias is defined" do
+    subject(:exposure) { entity.find_exposure :record_status }
+
+    it { is_expected.to have_key :status }
+    it { is_expected.not_to have_key :record_status }
+  end
+end

data/spec/matchers/have_root_matcher_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::HaveRootMatcher do
+  include RSpec::Grape::Entity::Matchers::HaveRootMatcher
+
+  context "when root is not defined" do
+    let(:described_class) do
+      Class.new Grape::Entity
+    end
+
+    it { expect(described_class).to have_root(nil) }
+    it { expect(described_class).to have_root(nil).with_singular(nil) }
+    it { expect(described_class).not_to have_root("tests") }
+    it { expect(described_class).not_to have_root("tests").with_singular(nil) }
+    it { expect(described_class).not_to have_root("tests").with_singular("test") }
+  end
+
+  context "when collection root is only defined" do
+    let(:described_class) do
+      Class.new Grape::Entity do
+        root "tests"
+      end
+    end
+
+    it { expect(described_class).not_to have_root(nil) }
+    it { expect(described_class).not_to have_root(nil).with_singular(nil) }
+    it { expect(described_class).to have_root("tests") }
+    it { expect(described_class).to have_root("tests").with_singular(nil) }
+    it { expect(described_class).not_to have_root("tests").with_singular("test") }
+  end
+
+  context "when both root and collection_root is defined" do
+    let(:described_class) do
+      Class.new Grape::Entity do
+        root "tests", "test"
+      end
+    end
+
+    it { expect(described_class).not_to have_root(nil) }
+    it { expect(described_class).not_to have_root(nil).with_singular(nil) }
+    it { expect(described_class).not_to have_root("tests") }
+    it { expect(described_class).not_to have_root("tests").with_singular(nil) }
+    it { expect(described_class).to have_root("tests").with_singular("test") }
+  end
+end

data/spec/matchers/include_documentation_matcher_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::IncludeDocumentationMatcher do
+  include RSpec::Grape::Entity::Matchers::IncludeDocumentationMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when has documentation" do
+    subject(:exposure) { entity.find_exposure :id }
+
+    it { is_expected.to include_documentation type: Integer, desc: "The record id" }
+    it { is_expected.to include_documentation type: Integer }
+    it { is_expected.to include_documentation desc: "The record id" }
+    it { is_expected.to include_documentation :type, :desc }
+    it { is_expected.to include_documentation :desc }
+    it { is_expected.to include_documentation :type }
+  end
+
+  context "when does not have documentation" do
+    subject(:exposure) { entity.find_exposure :permissions }
+
+    it { is_expected.not_to include_documentation type: Integer, desc: "Permissions" }
+    it { is_expected.not_to include_documentation type: Integer }
+    it { is_expected.not_to include_documentation desc: "The record id" }
+    it { is_expected.not_to include_documentation :type, :desc }
+    it { is_expected.not_to include_documentation :desc }
+    it { is_expected.not_to include_documentation :type }
+  end
+end

data/spec/matchers/matcher_helpers_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::MatcherHelpers do
+  let(:entity) { TestEntity }
+  subject(:helper) { Class.new { extend RSpec::Grape::Entity::Matchers::MatcherHelpers } }
+
+  describe ".entity_class_name" do
+    subject { helper.entity_class_name entity }
+
+    context "when a class constant" do
+      it { is_expected.to eq "TestEntity" }
+    end
+
+    context "when an instance of an entity" do
+      let(:entity) { TestEntity.new(nil) }
+      it { is_expected.to eq "TestEntity" }
+    end
+  end
+
+  describe ".exposure_attribute" do
+    let(:exposure) { entity.find_exposure :id }
+    subject { helper.exposure_attribute exposure, attribute }
+
+    context "when a valid exposure attribute" do
+      let(:attribute) { :key }
+      it { is_expected.to_not be_nil }
+    end
+
+    context "when an invalid exposure attribute" do
+      let(:attribute) { :not_a_real_attribute }
+      it { expect { subject }.to raise_error NoMethodError }
+    end
+  end
+
+  describe ".exposure_type" do
+    subject { helper.exposure_type exposure_type }
+
+    context "when a block exposure" do
+      let(:exposure_type) { :block }
+      it { is_expected.to be Grape::Entity::Exposure::BlockExposure }
+    end
+
+    context "when a delegator exposure" do
+      let(:exposure_type) { :delegator }
+      it { is_expected.to be Grape::Entity::Exposure::DelegatorExposure }
+    end
+
+    context "when a formatter exposure" do
+      let(:exposure_type) { :formatter }
+      it { is_expected.to be Grape::Entity::Exposure::FormatterExposure }
+    end
+
+    context "when a formatter block exposure" do
+      let(:exposure_type) { :formatter_block }
+      it { is_expected.to be Grape::Entity::Exposure::FormatterBlockExposure }
+    end
+
+    context "when a nesting exposure" do
+      let(:exposure_type) { :nesting }
+      it { is_expected.to be Grape::Entity::Exposure::NestingExposure }
+    end
+
+    context "when a represent exposure" do
+      let(:exposure_type) { :represent }
+      it { is_expected.to be Grape::Entity::Exposure::RepresentExposure }
+    end
+
+    context "when an invalid exposure type" do
+      let(:exposure_type) { :invalid_exposure_type }
+
+      it { expect { subject }.to raise_error NameError }
+    end
+  end
+end

data/spec/matchers/override_exposure_matcher_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RSpec::Grape::Entity::Matchers::OverrideExposureMatcher do
+  include RSpec::Grape::Entity::Matchers::OverrideExposureMatcher
+
+  let(:entity) { TestEntity }
+
+  context "when overriding" do
+    subject(:exposure) { entity.find_exposure :permissions }
+    it { is_expected.to override_exposure }
+  end
+
+  context "when not overriding" do
+    subject(:exposure) { entity.find_exposure :id }
+    it { is_expected.not_to override_exposure }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "time"
+
+require "rspec-grape-entity"
+
+require_relative "support/user_entity"
+require_relative "support/test_entity"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/support/test_entity.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class TestEntity < Grape::Entity
+  root "test_items", "test_item"
+
+  format_with :iso_timestamp, &:iso8601
+
+  expose :id, documentation: { type: Integer, desc: "The record id" }
+  expose :record_status, as: :status, if: :all
+  expose :user, safe: true, using: UserEntity, if: { type: :admin }
+  expose :custom_data, merge: true do |_, _|
+    {
+      foo: :bar
+    }
+  end
+  expose :permissions, override: true do
+    expose :read
+    expose :update
+    expose :destroy
+  end
+  expose :created_at, format_with: ->(date) { date.iso8601 }, if: ->(instance, _) { instance.has_date }
+  expose :updated_at, format_with: :iso_timestamp
+end

data/spec/support/user_entity.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class UserEntity < Grape::Entity
+  format_with :iso_timestamp, &:iso8601
+
+  expose :username
+  expose :name do
+    expose :first_name, as: :first, documentation: { type: String, desc: "User's last name" }
+    expose :last_name, as: :last, documentation: { type: String, desc: "User's last name" }
+  end
+  expose :joined_at, format_with: :iso_timestamp
+end