grape-entity 0.10.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a89222a95fe66dc86d907762352275aa328a0423a461e2f5a7c8fc806a92f09
-  data.tar.gz: a06ad75430e568a7e4cd2e9b6b329011e8382003c5882f690199403be58928c7
+  metadata.gz: e0f0e5dbd15616782e392614348386ade34ec6c0a2ab27c75603fc654adf068e
+  data.tar.gz: d412d26ef311e83c489aacbc84d6e8f7caabcae3c0d43dc22120d135d184aa00
 SHA512:
-  metadata.gz: 1bc3419fea51eb0c7c7c78f8f4e510c9d73bfe210cee2aa1f2aaaee92725d02334ab235818a37300c733c0970c9ee40cf56a022b421937ec6662d3e67da3e85f
-  data.tar.gz: 4f31cb8e01fbba21883bbf432fa557d0ca7f85d3c1d42a0aac0e4143c4add3af37e7f24b4fc315ff55502a640bffa0d185e8c3081d8a8b5492d45dc1b0102233
+  metadata.gz: fd34cb1b90bb0353ea4097cab79027cb77cdb9c44dd2ad3fa73595d01e29395e94233165ad6d049380e0200aef3bec792ea5f22ecb3bb94ecf4e72e9a22fcc45
+  data.tar.gz: afa32b651692da1cc7dc604181360166f3799ae66b17901d93c5ba90b17f98b5d038ec2c4cd08f62a83e5d548c9cce18f5664518c2170f4dc31307d48339146e

data/.github/workflows/ci.yml

@@ -15,10 +15,10 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.0'
           bundler-cache: true
       - name: Run rubocop
         run: bundle exec rubocop --parallel --format progress
@@ -28,10 +28,10 @@ jobs:
     needs: ['rubocop']
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', 'head', jruby, truffleruby]
+        ruby-version: ['3.0', '3.1', '3.2', '3.3', 'head']
     steps:
     - name: Check out branch
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - vendor/**/*
     - example/**/*
   NewCops: enable
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.0
   SuggestExtensions: false
 
 #  Layout stuff
@@ -38,7 +38,7 @@ Lint/ConstantDefinitionInBlock:
 #
 Metrics/AbcSize:
   Max: 25
-  IgnoredMethods:
+  AllowedMethods:
     # from lib/grape_entity/exposure/nesting_exposure.rb
     - 'normalized_exposures'
 
@@ -59,7 +59,7 @@ Metrics/MethodLength:
 
 Metrics/PerceivedComplexity:
   Max: 11
-  IgnoredMethods:
+  AllowedMethods:
     # from lib/grape_entity/entity.rb
     - 'expose'
     - 'merge_options'

data/CHANGELOG.md

@@ -9,6 +9,22 @@
 * Your contribution here.
 
 
+### ### 1.0.1 (2024-04-10)
+
+#### Fixes
+
+* [#381](https://github.com/ruby-grape/grape-entity/pull/381): Fix `expose_nil: false` when using a block - [@magni-](https://github.com/magni-).
+
+
+### ### 1.0.0 (2023-02-16)
+
+#### Fixes
+
+**Breaking change:**
+* [#352](https://github.com/ruby-grape/grape-entity/pull/369): Remove `FetchableObject` behavior. - [@danielvdao](https://github.com/danielvdao).
+* [#371](https://github.com/ruby-grape/grape-entity/pull/371): Allow default exposed value to be `false` or any empty data - [@norydev](https://github.com/norydev).
+
+
 ### 0.10.2 (2022-07-29)
 
 #### Fixes

data/Gemfile

@@ -5,7 +5,15 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubocop', '~> 1.0', require: false
+  gem 'bundler'
+  gem 'maruku'
+  gem 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  gem 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec', '~> 3.9'
+  gem 'rubocop', '~> 1.0'
+  gem 'yard'
 end
 
 group :test do

data/UPGRADING.md

@@ -1,6 +1,11 @@
 # Upgrading Grape Entity
 
 
+### Upgrading to >= 0.10.2
+Official support for `FetchableObject` was removed.
+
+See [#352](https://github.com/ruby-grape/grape-entity/pull/369) for more information.
+
 ### Upgrading to >= 0.8.2
 
 Official support for ruby < 2.5 removed, ruby 2.5 only in testing mode, but no support.

data/grape-entity.gemspec

@@ -7,28 +7,19 @@ Gem::Specification.new do |s|
   s.name        = 'grape-entity'
   s.version     = GrapeEntity::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Michael Bleigh']
-  s.email       = ['michael@intridea.com']
+  s.authors     = ['LeFnord', 'Michael Bleigh']
+  s.email       = ['pscholz.le@gmail.com', 'michael@intridea.com']
   s.homepage    = 'https://github.com/ruby-grape/grape-entity'
   s.summary     = 'A simple facade for managing the relationship between your model and API.'
   s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 3.0'
 
   s.add_runtime_dependency 'activesupport', '>= 3.0.0'
   # FIXME: remove dependecy
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
 
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'maruku'
-  s.add_development_dependency 'pry' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'pry-byebug' unless RUBY_PLATFORM.eql?('java') || RUBY_ENGINE.eql?('rbx')
-  s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 3.9'
-  s.add_development_dependency 'yard'
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
   s.require_paths = ['lib']

data/lib/grape_entity/condition/base.rb

@@ -4,8 +4,8 @@ module Grape
   class Entity
     module Condition
       class Base
-        def self.new(inverse, *args, &block)
-          super(inverse).tap { |e| e.setup(*args, &block) }
+        def self.new(inverse, ...)
+          super(inverse).tap { |e| e.setup(...) }
         end
 
         def initialize(inverse = false)

data/lib/grape_entity/delegator.rb

@@ -3,7 +3,6 @@
 require 'grape_entity/delegator/base'
 require 'grape_entity/delegator/hash_object'
 require 'grape_entity/delegator/openstruct_object'
-require 'grape_entity/delegator/fetchable_object'
 require 'grape_entity/delegator/plain_object'
 
 module Grape
@@ -15,8 +14,6 @@ module Grape
             HashObject
           elsif defined?(OpenStruct) && object.is_a?(OpenStruct)
             OpenStructObject
-          elsif object.respond_to?(:fetch, true)
-            FetchableObject
           else
             PlainObject
           end

data/lib/grape_entity/entity.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'multi_json'
-require 'set'
 
 module Grape
   # An Entity is a lightweight structure that allows you to easily
@@ -599,10 +598,10 @@ module Grape
           if existing_val.is_a?(Hash) && new_val.is_a?(Hash)
             existing_val.merge(new_val)
           elsif new_val.is_a?(Hash)
-            (opts["#{key}_extras".to_sym] ||= []) << existing_val
+            (opts[:"#{key}_extras"] ||= []) << existing_val
             new_val
           else
-            (opts["#{key}_extras".to_sym] ||= []) << new_val
+            (opts[:"#{key}_extras"] ||= []) << new_val
             existing_val
           end
         else

data/lib/grape_entity/exposure/base.rb

@@ -9,8 +9,8 @@ module Grape
       class Base
         attr_reader :attribute, :is_safe, :documentation, :override, :conditions, :for_merge
 
-        def self.new(attribute, options, conditions, *args, &block)
-          super(attribute, options, conditions).tap { |e| e.setup(*args, &block) }
+        def self.new(attribute, options, conditions, ...)
+          super(attribute, options, conditions).tap { |e| e.setup(...) }
         end
 
         def initialize(attribute, options, conditions)
@@ -89,7 +89,7 @@ module Grape
           return unless valid?(entity)
 
           output = value(entity, options)
-          output.blank? && @default_value.present? ? @default_value : output
+          output.blank? && !@default_value.nil? ? @default_value : output
         end
 
         def should_return_key?(options)

data/lib/grape_entity/exposure.rb

@@ -54,7 +54,7 @@ module Grape
 
         def expose_nil_condition(attribute, options)
           Condition.new_unless(
-            proc do |object, _options|
+            proc do |object, entity_options|
               if options[:proc].nil?
                 delegator = Delegator.new(object)
                 if is_a?(Grape::Entity) && delegator.accepts_options?
@@ -63,7 +63,7 @@ module Grape
                   delegator.delegate(attribute).nil?
                 end
               else
-                exec_with_object(options, &options[:proc]).nil?
+                exec_with_object(entity_options, &options[:proc]).nil?
               end
             end
           )

data/lib/grape_entity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeEntity
-  VERSION = '0.10.2'
+  VERSION = '1.0.1'
 end

data/spec/grape_entity/entity_spec.rb

@@ -30,7 +30,11 @@ describe Grape::Entity do
 
         it 'makes sure that :format_with as a proc cannot be used with a block' do
           # rubocop:disable Style/BlockDelimiters
-          expect { subject.expose :name, format_with: proc {} do p 'hi' end }.to raise_error ArgumentError
+          expect {
+            subject.expose :name, format_with: proc {} do
+              p 'hi'
+            end
+          }.to raise_error ArgumentError
           # rubocop:enable Style/BlockDelimiters
         end
 
@@ -129,8 +133,8 @@ describe Grape::Entity do
 
           context 'when expose_nil option is false and block passed' do
             it 'does not expose if block returns nil' do
-              subject.expose(:a, expose_nil: false) do |_obj, _options|
-                nil
+              subject.expose(:a, expose_nil: false) do |_obj, options|
+                options[:option_a]
               end
               subject.expose(:b)
               subject.expose(:c)
@@ -138,12 +142,12 @@ describe Grape::Entity do
             end
 
             it 'exposes is block returns a value' do
-              subject.expose(:a, expose_nil: false) do |_obj, _options|
-                100
+              subject.expose(:a, expose_nil: false) do |_obj, options|
+                options[:option_a]
               end
               subject.expose(:b)
               subject.expose(:c)
-              expect(subject.represent(model).serializable_hash).to eq(a: 100, b: nil, c: 'value')
+              expect(subject.represent(model, option_a: 100).serializable_hash).to eq(a: 100, b: nil, c: 'value')
             end
           end
         end
@@ -245,9 +249,9 @@ describe Grape::Entity do
           context 'when default option is set' do
             it 'exposes default values for attributes' do
               subject.expose(:a, default: 'a')
-              subject.expose(:b, default: 'b')
+              subject.expose(:b, default: false)
               subject.expose(:c, default: 'c')
-              expect(subject.represent(model).serializable_hash).to eq(a: 'a', b: 'b', c: 'value')
+              expect(subject.represent(model).serializable_hash).to eq(a: 'a', b: false, c: 'value')
             end
           end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-entity
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 1.0.1
 platform: ruby
 authors:
+- LeFnord
 - Michael Bleigh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,121 +39,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
-- !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'
-- !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: 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:
-    - - ">="
-      - !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: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !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'
 description: Extracted from Grape, A Ruby framework for rapid API development with
   great conventions.
 email:
+- pscholz.le@gmail.com
 - michael@intridea.com
 executables: []
 extensions: []
@@ -187,7 +77,6 @@ files:
 - 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
@@ -224,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: A simple facade for managing the relationship between your model and API.

data/lib/grape_entity/delegator/fetchable_object.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  class Entity
-    module Delegator
-      class FetchableObject < Base
-        def delegate(attribute)
-          object.fetch attribute
-        end
-      end
-    end
-  end
-end