grape-entity 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04e39a2c99114bcf750f4ca63fa6119ffa0cd5ca
-  data.tar.gz: 1875a1693ff3de51c40db11a8c755464a93f09bd
+SHA256:
+  metadata.gz: ecd89442adb3e014be540761d005b20920e8aa847691a69a6c4e166d1ed63f21
+  data.tar.gz: c556531fdea49f03dfea0ce4d1388016736c7d3987db0957be30b27a82e21e40
 SHA512:
-  metadata.gz: 3cc6b4795400645718b1228affae6067dabb1214a13d033f0b979e096d649d03d9b05897df537c7e7d0cba2991914e958fe3d26f96b58c4ae62bfc51a63a42e7
-  data.tar.gz: 2cec009315195a548380c46fa057036a21f8e25b7da03a368f150a3cfe2a3e290c5c67b56ccce262db8a485a51b6b130d3d760e992a6aa7d863033af3a4494d7
+  metadata.gz: 5a48af786a0d681229aecd0765eccfafb9f28f6178dc5ade649d54b255df13e82f24f4f5243de7cdff9d45a423d101b851137ffb7920e3853529d88fbe23f67b
+  data.tar.gz: b9b89ee602c3804470c57e6519244e59b78fa5b10470fb2a5d0f1581e821847ab8a6f66145fcf57445090d654c442d33cfc6fa94c6eaea9e36f15ce1038eb362

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -31,9 +31,13 @@ pkg
 dist
 Gemfile.lock
 tmp
+coverage/
+.byebug_history
+.ruby-version
+.ruby-gemset
 
 ## Rubinius
 .rbx
 
 ## PROJECT::SPECIFIC
-.project
+.project

data/.rubocop.yml

@@ -1,6 +1,37 @@
 AllCops:
+  TargetRubyVersion: 2.4
+  Include:
+    - Dangerfile
+
   Exclude:
     - vendor/**/*
+    - bin/**/*
     - Guardfile
 
 inherit_from: .rubocop_todo.yml
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'grape-entity.gemspec'
+    - 'lib/grape-entity.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Exclude:
+    - 'spec/grape_entity/exposure_spec.rb'
+
+Lint/UnneededDisable:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,31 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-20 10:04:42 -0500 using RuboCop version 0.45.0.
+# on 2018-01-11 18:20:10 +0100 using RuboCop version 0.52.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/grape_entity/exposure/represent_exposure_spec.rb'
+
 # Offense count: 6
 Metrics/AbcSize:
   Max: 32
 
+# Offense count: 35
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 1625
+
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 208
+  Max: 210
 
-# Offense count: 3
+# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 237
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 146
-
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 28
@@ -34,12 +38,21 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 13
 
-# Offense count: 33
-Style/Documentation:
-  Enabled: false
+# Offense count: 1
+Style/EvalWithLocation:
+  Exclude:
+    - 'lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+# IgnoredMethods: respond_to, define_method
+Style/SymbolProc:
   Exclude:
-    - 'lib/grape-entity.rb'
+    - 'spec/grape_entity/entity_spec.rb'
+
+# Offense count: 250
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 146

data/.travis.yml

@@ -2,24 +2,29 @@ sudo: false
 
 language: ruby
 
-cache: bundler
-bundler_args: --without test
+before_install:
+  - gem update --system
+  - gem install bundler
+
+after_success:
+  - coveralls
+  - bundle exec danger
+
+rvm:
+  - 2.5.0
+  - 2.4.3
 
 matrix:
+  fast_finish: true
+
   include:
-    - rvm: 2.4.0
-      script:
-        - bundle exec danger
-    - rvm: 2.4.0
-    - rvm: 2.3.3
-    - rvm: 2.2.6
+    - rvm: 2.3.6
     - rvm: ruby-head
-    - rvm: jruby-9.1.6.0
     - rvm: jruby-head
     - rvm: rbx-2
 
   allow_failures:
+    - rvm: 2.3.6
     - rvm: ruby-head
-    - rvm: jruby-9.1.6.0
     - rvm: jruby-head
     - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,24 @@
 
 * Your contribution here.
 
+### 0.7.0 (2018-01-25)
+
+#### Features
+
+* [#287](https://github.com/ruby-grape/grape-entity/pull/287): Adds ruby 2.5, drops ruby 2.2 support - [@LeFnord](https://github.com/LeFnord).
+* [#277](https://github.com/ruby-grape/grape-entity/pull/277): Provide grape::entity::options#dig - [@kachick](https://github.com/kachick).
+* [#265](https://github.com/ruby-grape/grape-entity/pull/265): Adds ability to provide a proc to as: - [@james2m](https://github.com/james2m).
+* [#264](https://github.com/ruby-grape/grape-entity/pull/264): Adds Rubocop config and todo list - [@james2m](https://github.com/james2m).
+* [#255](https://github.com/ruby-grape/grape-entity/pull/255): Adds code coverage w/ coveralls - [@LeFnord](https://github.com/LeFnord).
+* [#268](https://github.com/ruby-grape/grape-entity/pull/268): Loosens the version dependency for activesupport - [@anakinj](https://github.com/anakinj).
+* [#293](https://github.com/ruby-grape/grape-entity/pull/293): Adds expose_nil option - [@b-boogaard](https://github.com/b-boogaard).
+
+#### Fixes
+
+* [#288](https://github.com/ruby-grape/grape-entity/pull/288): Fix wrong argument exception when `&:block` passed to the expose method  - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
+* [#291](https://github.com/ruby-grape/grape-entity/pull/291): Refactor and simplify various classes and modules  - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
+* [#292](https://github.com/ruby-grape/grape-entity/pull/292): Allow replace non-conditional non-nesting exposures in child classes (fixes  [#286](https://github.com/ruby-grape/grape-entity/issues/286)) - [@DmitryTsepelev](https://github.com/DmitryTsepelev).
+
 ### 0.6.1 (2017-01-09)
 
 #### Features

data/Dangerfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,15 +1,20 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
 group :development, :test do
-  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'rubocop', '~> 0.51', require: false
 end
 
 group :test do
+  gem 'coveralls', require: false
   gem 'growl'
   gem 'guard'
   gem 'guard-bundler'
   gem 'guard-rspec'
   gem 'rb-fsevent'
+  gem 'ruby-grape-danger', '~> 0.1.1', require: false
+  gem 'simplecov', require: false
 end

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](http://img.shields.io/gem/v/grape-entity.svg)](http://badge.fury.io/rb/grape-entity)
 [![Build Status](http://img.shields.io/travis/ruby-grape/grape-entity.svg)](https://travis-ci.org/ruby-grape/grape-entity)
+[![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape-entity/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape-entity?branch=master)
 [![Dependency Status](https://gemnasium.com/ruby-grape/grape-entity.svg)](https://gemnasium.com/ruby-grape/grape-entity)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape-entity.svg)](https://codeclimate.com/github/ruby-grape/grape-entity)
 
@@ -320,7 +321,7 @@ module Entities
     with_options(format_with: :iso_timestamp) do
       expose :created_at
       expose :updated_at
-    end    
+    end
   end
 end
 ```
@@ -349,6 +350,86 @@ module Entities
 end
 ```
 
+#### Expose Nil
+
+By default, exposures that contain `nil` values will be represented in the resulting JSON as `null`.
+
+As an example, a hash with the following values:
+
+```ruby
+{
+  name: nil,
+  age: 100
+}
+```
+
+will result in a JSON object that looks like:
+
+```javascript
+{
+  "name": null,
+  "age": 100
+}
+```
+
+There are also times when, rather than displaying an attribute with a `null` value, it is more desirable to not display the attribute at all. Using the hash from above the desired JSON would look like:
+
+```javascript
+{
+  "age": 100
+}
+```
+
+In order to turn on this behavior for an as-exposure basis, the option `expose_nil` can be used. By default, `expose_nil` is considered to be `true`, meaning that `nil` values will be represented in JSON as `null`. If `false` is provided, then attributes with `nil` values will be omitted from the resulting JSON completely.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    expose :name, expose_nil: false
+    expose :age, expose_nil: false
+  end
+end
+```
+
+`expose_nil` is per exposure, so you can suppress exposures from resulting in `null` or express `null` values on a per exposure basis as you need:
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    expose :name, expose_nil: false
+    expose :age # since expose_nil is omitted nil values will be rendered as null
+  end
+end
+```
+
+It is also possible to use `expose_nil` with `with_options` if you want to add the configuration to multiple exposures at once.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    # None of the exposures in the with_options block will render nil values as null
+    with_options(expose_nil: false) do
+      expose :name
+      expose :age
+    end
+  end
+end
+```
+
+When using `with_options`, it is possible to again override which exposures will render `nil` as `null` by adding the option on a specific exposure.
+
+```ruby
+module  Entities
+  class MyModel < Grape::Entity
+    # None of the exposures in the with_options block will render nil values as null
+    with_options(expose_nil: false) do
+      expose :name
+      expose :age, expose_nil: true # nil values would be rendered as null in the JSON
+    end
+  end
+end
+```
+
 #### Documentation
 
 Expose documentation with the field. Gets bubbled up when used with Grape and various API documentation systems.

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
@@ -17,4 +17,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/bench/serializing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'grape-entity'
 require 'benchmark'

data/grape-entity.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'grape_entity/version'
 
@@ -12,22 +14,22 @@ Gem::Specification.new do |s|
   s.description = 'Extracted from Grape, A Ruby framework for rapid API development with great conventions.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.2.6'
+  s.required_ruby_version = '>= 2.3'
 
   s.rubyforge_project = 'grape-entity'
 
+  s.add_runtime_dependency 'activesupport', '>=4.0'
+  # FIXME: remove dependecy
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'
-  s.add_runtime_dependency 'activesupport', '>= 5.0.0'
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rubocop', '~> 0.40'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'maruku'
-  s.add_development_dependency 'yard'
   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.0'
+  s.add_development_dependency 'yard'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

data/lib/grape-entity.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'grape_entity'

data/lib/grape_entity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/version'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/hash/reverse_merge'

data/lib/grape_entity/condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape_entity/condition/base'
 require 'grape_entity/condition/block_condition'
 require 'grape_entity/condition/hash_condition'
@@ -6,19 +8,26 @@ require 'grape_entity/condition/symbol_condition'
 module Grape
   class Entity
     module Condition
-      def self.new_if(arg)
-        case arg
-        when Hash then HashCondition.new false, arg
-        when Proc then BlockCondition.new false, &arg
-        when Symbol then SymbolCondition.new false, arg
+      class << self
+        def new_if(arg)
+          condition(false, arg)
         end
-      end
 
-      def self.new_unless(arg)
-        case arg
-        when Hash then HashCondition.new true, arg
-        when Proc then BlockCondition.new true, &arg
-        when Symbol then SymbolCondition.new true, arg
+        def new_unless(arg)
+          condition(true, arg)
+        end
+
+        private
+
+        def condition(inverse, arg)
+          condition_klass =
+            case arg
+            when Hash then HashCondition
+            when Proc then BlockCondition
+            when Symbol then SymbolCondition
+            end
+
+          condition_klass.new(inverse, arg)
         end
       end
     end