bright_serializer 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae3444c6b0be4fc77c338286c25e97acc5501aeac9af722a53bf1182dad6034c
-  data.tar.gz: 75461556470937cd50f91326e591c73aea3a089cbfe3961200a8420d6682c019
+  metadata.gz: 193184e7a6c008dc18745e187bbf375a9c42a6568d0730ed39dcea3c04888115
+  data.tar.gz: e574c34963493d24af6039f534f4074e398d0515f30d6d4ae716c0e8ffbbad33
 SHA512:
-  metadata.gz: 17d5c832abe849c799e4c5240bdfda4ed8e292f0284a3004908d0e812a0bb90268f85be8f1e416c83b596446aec0bcef38d02d1e26e607fe6da902dfc6daa69f
-  data.tar.gz: 7e78a38854d53707fd8f6cd4eb3df7368f045fc20f086df1fd592c07cf723b69de458c2bfc2890457d245633f716bbc1e8d379cb0318f8486809fc42ff37fd72
+  metadata.gz: 4271988147d4f68f39a1846d7cbcbdba6cbc445e2ee28c58160f8a124658cd6cebd4bebf5e0c5e4f56c811229ccb295c44e914ddeaba4c0289fe232c12cf0b59
+  data.tar.gz: ee98dfaf4e70a123bfe5ea46dc0817e0beaefb93238f21ed856da0eb5e722a864c9bc42256611ec81bdd6722d3f751afb9e1b8d1a42b8219c7a77c3fbabe1180

data/CHANGELOG.md

@@ -2,7 +2,17 @@
 
 ## master (unreleased)
 
-* Your contribution
+## 0.3.1 (2022-09-28)
+
+* Performance improvements, use nil instead of empty set. ([#97](https://github.com/petalmd/bright_serializer/pull/97))
+* Move specs out of lib. ([#96](https://github.com/petalmd/bright_serializer/pull/96))
+
+## 0.3.0 (2022-05-26)
+
+* Allow to evaluate entity values with a callable lambda. ([#88](https://github.com/petalmd/bright_serializer/pull/88))
+* Fix `FrozenError (can't modify frozen Array)` when parsing entity. ([#83](https://github.com/petalmd/bright_serializer/pull/83))
+* Added the support to use instance methods from a serializer class in the library ([#85](https://github.com/petalmd/bright_serializer/pull/85))
+* Use real coveralls_reborn gem
 
 ## 0.2.5 (2021-03-08)
 
@@ -33,7 +43,7 @@
 * Define entity in serializer for grape_swagger ([#9](https://github.com/petalmd/bright_serializer/pull/9))
 
 ## 0.1.1 (2020-07-13)
- 
+
 * Add description in gemspec file
 * Add content in CHANGELOG.md
 

data/Gemfile

@@ -10,6 +10,7 @@ gemspec
 gem 'oj', require: false
 
 group :test do
+  gem 'coveralls_reborn', require: false
   gem 'faker'
   gem 'rubocop'
   gem 'rubocop-performance'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bright_serializer (0.2.5)
+    bright_serializer (0.3.1)
       oj (~> 3)
 
 GEM
@@ -9,7 +9,13 @@ GEM
   specs:
     ast (2.4.1)
     concurrent-ruby (1.1.7)
+    coveralls_reborn (0.22.0)
+      simplecov (>= 0.18.1, < 0.22.0)
+      term-ansicolor (~> 1.6)
+      thor (>= 0.20.3, < 2.0)
+      tins (~> 1.16)
     diff-lcs (1.4.4)
+    docile (1.4.0)
     faker (2.15.1)
       i18n (>= 1.6, < 2)
     i18n (1.8.5)
@@ -53,6 +59,18 @@ GEM
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -61,6 +79,7 @@ PLATFORMS
 DEPENDENCIES
   bright_serializer!
   bundler (~> 2)
+  coveralls_reborn
   faker
   oj
   rake (~> 13.0)
@@ -70,4 +89,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -1,5 +1,6 @@
 [![Actions Status](https://github.com/petalmd/bright_serializer/workflows/Build/badge.svg)](https://github.com/petalmd/bright_serializer/actions?query=workflow%3ABuild)
 [![Gem Version](https://badge.fury.io/rb/bright_serializer.svg)](https://badge.fury.io/rb/bright_serializer)
+[![Coverage Status](https://coveralls.io/repos/github/petalmd/bright_serializer/badge.svg?branch=master)](https://coveralls.io/github/petalmd/bright_serializer?branch=master)
 
 # BrightSerializer
 
@@ -31,12 +32,12 @@ Create a class and include `BrightSerializer::Serializer`
 class AccountSerializer
   include BrightSerializer::Serializer
   attributes :id, :first_name, :last_name
-  
+
   # With a block
   attribute :name do |object|
     "#{object.first_name} #{object.last_name}"
   end
-  
+
   # With a block shorter
   attribute :created_at, &:to_s
 end
@@ -53,7 +54,7 @@ You can pass params to your serializer. For example to have more context with th
 class AccountSerializer
   include BrightSerializer::Serializer
   attributes :id, :first_name, :last_name
-  
+
   attribute :friend do |object, params|
     object.is_friend_with? params[:current_user]
   end
@@ -65,14 +66,14 @@ AccountSerializer.new(Account.first, params: { current_user: current_user }).to_
 
 ### Conditional Attributes
 
-Attribute can be remove from serialization by passing a `proc` to the option `if`. If the proc return `true` the attibute 
- will be serialize. `object` and `params` or accessible. 
+Attribute can be remove from serialization by passing a `proc` to the option `if`. If the proc return `true` the attibute
+ will be serialize. `object` and `params` or accessible.
 
 ```ruby
 class AccountSerializer
   include BrightSerializer::Serializer
   attributes :id, :first_name, :last_name
-  
+
   attribute :email, if: -> { |object, params| params[:current_user].is_admin? }
 end
 ```
@@ -118,7 +119,7 @@ end
 class AccountSerializer
   include BrightSerializer::Serializer
   attributes :id, :first_name, :last_name
-  
+
   attribute :friends do |object|
     FriendSerializer.new(object.friends)
   end
@@ -128,7 +129,7 @@ end
 ### Entity
 
 You can define the entity of your serializer to generate documentation with the option `entity`.
-The feature was build to work with [grape-swagger](https://github.com/ruby-grape/grape-swagger). 
+The feature was build to work with [grape-swagger](https://github.com/ruby-grape/grape-swagger).
 For more information about defining a model entity see the [Swagger documentation](https://swagger.io/specification/v2/?sbsearch=array%20response#schema-object).
 
 ```ruby
@@ -138,12 +139,37 @@ class AccountSerializer
   attribute :name
 
   attribute :friends,
-    entity: { 
+    entity: {
       type: :array, items: { ref: 'FriendSerializer' }, description: 'The list the account friends.'
      } do |object|
     FriendSerializer.new(object.friends)
   end
 end
+
+```
+Callable values are supported.
+
+```ruby
+{ entity: { type: :string, enum: -> { SomeModel::ENUMVALUES } } }
+```
+
+### Instance
+
+If you have defined instance methods inside your serializer you can access them inside block attribute.
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :name
+
+  attribute :print do |object|
+    print_account(object)
+  end
+
+  def print_account(object)
+    "Account: #{object.name}"
+  end
+end
 ```
 
 ## Development

data/lib/bright_serializer/attribute.rb

@@ -14,12 +14,16 @@ module BrightSerializer
       @entity = entity ? Entity::Base.new(entity) : nil
     end
 
-    def serialize(object, params)
+    def serialize(serializer_instance, object, params)
       return unless object
 
       value =
         if @block
-          @block.arity.abs == 1 ? object.instance_eval(&@block) : object.instance_exec(object, params, &@block)
+          if @block.arity.abs == 1
+            serializer_instance.instance_exec(object, &@block)
+          else
+            serializer_instance.instance_exec(object, params, &@block)
+          end
         elsif object.is_a?(Hash)
           object.key?(key) ? object[key] : object[key.to_s]
         else

data/lib/bright_serializer/entity/base.rb

@@ -14,8 +14,9 @@ module BrightSerializer
       end
 
       def to_h
-        Inflector.deep_transform_keys_in_object!(@definition) { |k| Inflector.camel_lower k.to_s }
+        @definition = Inflector.deep_transform_keys_in_object(@definition) { |k| Inflector.camel_lower k.to_s }
         parse_ref!
+        evaluate_callable!
         @definition
       end
 
@@ -28,6 +29,12 @@ module BrightSerializer
         object['$ref'] = relation
       end
 
+      def evaluate_callable!
+        @definition = Inflector.deep_transform_values_in_object(@definition) do |value|
+          value.respond_to?(:call) ? value.call : value
+        end
+      end
+
       def nested_hash(obj, key)
         if obj.respond_to?(:key?) && obj.key?(key)
           obj

data/lib/bright_serializer/inflector.rb

@@ -60,20 +60,30 @@ class Inflector
       end
     end
 
-    # File active_support/core_ext/hash/keys.rb, line 156
-    def deep_transform_keys_in_object!(object, &block)
+    # File active_support/core_ext/hash/keys.rb, line 116
+    def deep_transform_keys_in_object(object, &block)
       case object
       when Hash
-        object.keys.each do |key| # rubocop:disable Style/HashEachMethods
-          value = object.delete(key)
-          object[yield(key)] = deep_transform_keys_in_object!(value, &block)
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys_in_object(value, &block)
         end
-        object
       when Array
-        object.map! { |e| deep_transform_keys_in_object!(e, &block) }
+        object.map { |e| deep_transform_keys_in_object(e, &block) }
       else
         object
       end
     end
+
+    # File active_support/core_ext/hash/deep_transform_values.rb, line 25
+    def deep_transform_values_in_object(object, &block)
+      case object
+      when Hash
+        object.transform_values { |value| deep_transform_values_in_object(value, &block) }
+      when Array
+        object.map { |e| deep_transform_values_in_object(e, &block) }
+      else
+        yield(object)
+      end
+    end
   end
 end

data/lib/bright_serializer/serializer.rb

@@ -20,15 +20,17 @@ module BrightSerializer
     def initialize(object, **options)
       @object = object
       @params = options.delete(:params)
-      @fields = Set.new(options.delete(:fields))
+
+      fields = options.delete(:fields)
+      @fields = fields ? Set.new(fields) : nil
     end
 
     def serialize(object)
       self.class.attributes_to_serialize.each_with_object({}) do |attribute, result|
-        next if @fields.any? && !@fields.include?(attribute.key)
+        next if !@fields.nil? && !@fields.include?(attribute.key)
         next unless attribute.condition?(object, @params)
 
-        result[attribute.transformed_key] = attribute.serialize(object, @params)
+        result[attribute.transformed_key] = attribute.serialize(self, object, @params)
       end
     end
 

data/lib/bright_serializer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrightSerializer
-  VERSION = '0.2.5'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Light and fast Ruby serializer