bright_serializer 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840379a67e4354592d042785306facc35b8e663ed8cc27da09b9158b3d43fc6f
-  data.tar.gz: 817cf7a8dca2434c8e89cf3813678c1005086d9edb0fd11c76c4a3461470873f
+  metadata.gz: ccd3ca73a3a175ff41e1b661b1d4287e330e51fac24cc4483e88f231d711006c
+  data.tar.gz: 2d326508db9454e2ff3923731572710caa07f11584f3cf06bf9634e851e5bbcc
 SHA512:
-  metadata.gz: 1a598fcf576edf3395723c01dbaa7c00c45bc76ad2363599b9e16af0a7f4662a55007a6de49073cc2bb2bf36ceb63320c3fcfd58459147917b041deda1ae3204
-  data.tar.gz: 711ca41015c6fed810bd22ae1ce1914d87f9b40fdb33b084b891b4134ea5af1d291a1bce95e608f9f8cd3babf25440f1cce05433c6a8ddd935a4b2c43eebc907
+  metadata.gz: 2c025a5b514015a760587254fb18e5a8eaf3d58e522031300f6d4a5a3049ba7af0462371cb951ec3637f471ffd015981a74affd8fc1d4d20b9fe87874d598082
+  data.tar.gz: 4a6182583ccb22ee99360852c3dc0ca6d8b097cba21dba8608062325f7958bc1a90f774b87e19e389785e042a90c7aab4da30f548efda101085e0f7af08bdc5e

data/README.md

@@ -205,6 +205,16 @@ class AccountSerializer
 end
 ```
 
+## Benchmark
+
+Event if the main goal is not performance, it has very good result.
+
+```sh
+ruby benchmarks/collection.rb
+```
+
+<img src="benchmarks/ips.png" width="400px">
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/bright_serializer/attribute.rb

@@ -32,7 +32,7 @@ module BrightSerializer
 
     def attribute_value(serializer_instance, object, params)
       if @block
-        if @block.arity.abs == 1
+        if @block.arity.negative?
           serializer_instance.instance_exec(object, &@block)
         else
           serializer_instance.instance_exec(object, params, &@block)

data/lib/bright_serializer/attribute_relation.rb

@@ -23,7 +23,7 @@ module BrightSerializer
     private
 
     def class_serializer
-      @class_serializer ||= @serializer.is_a?(String) ? Inflector.constantize(@serializer) : @serializer
+      @class_serializer ||= @serializer.is_a?(String) ? @serializer.constantize : @serializer
     end
 
     def add_entity_ref!(entity)

data/lib/bright_serializer/entity/base.rb

@@ -24,7 +24,7 @@ module BrightSerializer
         object = nested_hash(@definition, 'ref')
         return unless object
 
-        ref_entity_name = Inflector.constantize(object.delete('ref')).entity_name
+        ref_entity_name = object.delete('ref').constantize.entity_name
         relation = "#/definitions/#{ref_entity_name}"
         object['$ref'] = relation
       end

data/lib/bright_serializer/inflector.rb

@@ -29,37 +29,6 @@ class Inflector
       underscored_word
     end
 
-    # File activesupport/lib/active_support/inflector/methods.rb, line 271
-    def constantize(camel_cased_word)
-      names = camel_cased_word.split('::')
-
-      # Trigger a built-in NameError exception including the ill-formed constant in the message.
-      Object.const_get(camel_cased_word) if names.empty?
-
-      # Remove the first blank element in case of '::ClassName' notation.
-      names.shift if names.size > 1 && names.first.empty?
-
-      names.inject(Object) do |constant, name|
-        if constant == Object
-          constant.const_get(name)
-        else
-          candidate = constant.const_get(name)
-          next candidate if constant.const_defined?(name, false)
-          next candidate unless Object.const_defined?(name)
-
-          # Go down the ancestors to check if it is owned directly. The check
-          # stops when we reach Object or the end of ancestors tree.
-          constant = constant.ancestors.each_with_object(constant) do |ancestor, const|
-            break const    if ancestor == Object
-            break ancestor if ancestor.const_defined?(name, false)
-          end
-
-          # owner is in Object, so raise
-          constant.const_get(name, false)
-        end
-      end
-    end
-
     # File active_support/core_ext/hash/keys.rb, line 116
     def deep_transform_keys_in_object(object, &block)
       case object

data/lib/bright_serializer/serializer.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'oj'
-require 'active_support/deprecation'
 require_relative 'attribute'
 require_relative 'attribute_relation'
 require_relative 'inflector'
@@ -14,11 +13,6 @@ module BrightSerializer
 
     SUPPORTED_TRANSFORMATION = %i[camel camel_lower dash underscore].freeze
     DEFAULT_OJ_OPTIONS = { mode: :compat, time_format: :ruby, use_to_json: true }.freeze
-    DEPRECATION_MESSAGE = 'BrightSerializer: Serializing `nil` will stop returning ' \
-                  "a JSON with all attributes and null values.\n" \
-                  "To keep the old behaviour use an empty hash `MySerializer.new(object || { }).to_json`.\n" \
-                  "See: https://github.com/petalmd/bright_serializer/issues/103 for more details about this change.\n"
-    private_constant :DEPRECATION_MESSAGE
 
     def self.included(base)
       super
@@ -33,7 +27,7 @@ module BrightSerializer
     end
 
     def serialize(object, attributes_to_serialize)
-      ActiveSupport::Deprecation.warn(DEPRECATION_MESSAGE) if object.nil?
+      return nil if @object.nil?
 
       attributes_to_serialize.each_with_object({}) do |attribute, result|
         next unless attribute.condition?(object, @params)
@@ -68,8 +62,9 @@ module BrightSerializer
         subclass.instance_variable_set(:@transform_method, @transform_method) unless subclass.transform_method
       end
 
-      def attributes(*attributes, **options, &block)
-        attributes.each do |key|
+      def attributes(*args, &block)
+        options = args.extract_options!
+        args.each do |key|
           attribute = Attribute.new(key, options[:if], options[:entity], &block)
           attribute.transformed_key = run_transform_key(key)
           @attributes_to_serialize << attribute

data/lib/bright_serializer/version.rb

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

data/lib/bright_serializer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/array/extract_options'
 require 'bright_serializer/version'
 
 module BrightSerializer

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bright_serializer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,55 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -99,19 +43,12 @@ email:
 - jfbastien@petalmd.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bright_serializer.gemspec
 - lib/bright_serializer.rb
 - lib/bright_serializer/attribute.rb
 - lib/bright_serializer/attribute_relation.rb
@@ -127,8 +64,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/petalmd/bright_serializer
-  source_code_uri: https://github.com/petalmd/bright_serializer
   changelog_uri: https://github.com/petalmd/bright_serializer/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/petalmd/bright_serializer
+  bug_tracker_uri: https://github.com/petalmd/bright_serializer/issues
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# IDE files
-.idea/

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,44 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  DisplayStyleGuide: true # Include styleguide and reference URLs
-  ExtraDetails: true # Include cop details
-
-Metrics/BlockLength:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/NamedSubject:
-  Enabled: false
-
-Gemspec/RequiredRubyVersion:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Max: 6
-
-RSpec/NestedGroups:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.7.1

data/CHANGELOG.md

@@ -1,63 +0,0 @@
-# Change log
-
-## master (unreleased)
-
-## 0.4.1 (2022-04-10)
-
-* Add deprecation warning for serialize nil object. See [issue #103](https://github.com/petalmd/bright_serializer/issues/103). ([v0.4.0...v0.4.1](https://github.com/petalmd/bright_serializer/compare/v0.4.0...v0.4.1))
-
-## 0.4.0 (2022-11-10)
-
-* Added relation helper methods `has_one`, `has_many`, `belongs_to` ([#49](https://github.com/petalmd/bright_serializer/pull/49))
-* Performance improvements, save in instance attributes to serialize. ([#100](https://github.com/petalmd/bright_serializer/pull/100))
-* Performance improvements, calculate attributes to serialize only once. ([#98](https://github.com/petalmd/bright_serializer/pull/98))
-* Add instrumentation. ([#90](https://github.com/petalmd/bright_serializer/pull/90))
-
-## 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)
-
-* When serializing an Hash, check present of the key before trying string ([#57](https://github.com/petalmd/bright_serializer/pull/57))
-
-## 0.2.4 (2021-02-19)
-
-* Try symbol and string keys when the object to serialize is an Hash ([#54](https://github.com/petalmd/bright_serializer/pull/54))
-
-## 0.2.3 (2021-01-04)
-
-* Update dependencies ([v0.2.2...v0.2.3](https://github.com/petalmd/bright_serializer/compare/v0.2.2...v0.2.3))
-
-## 0.2.2 (2020-07-22)
-
-* Run CI build on all supported Ruby versions ([#11](https://github.com/petalmd/bright_serializer/pull/11))
-* Update Rubocop 0.78.0 => 0.88.0 and run auto-correction
-* Deep transform entity keys ([#12](https://github.com/petalmd/bright_serializer/pull/12))
-
-## 0.2.1 (2020-07-21)
-
-* Handle set_key_transform inherited from a parent serializer ([#10](https://github.com/petalmd/bright_serializer/pull/10))
-
-## 0.2.0 (2020-07-17)
-
-* Add RubyGems version badge
-* Handle inherit from a parent serializer
-* 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
-
-## 0.1.0 (2020-07-13)
-
-* First release

data/Gemfile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in bright_serializer.gemspec
-gemspec
-
-gem 'oj', require: false
-
-group :test do
-  gem 'coveralls_reborn', require: false
-  gem 'faker'
-  gem 'rubocop'
-  gem 'rubocop-performance'
-  gem 'rubocop-rspec'
-end

data/Gemfile.lock

@@ -1,102 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bright_serializer (0.4.1)
-      activesupport (>= 5.2)
-      oj (~> 3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.8.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    ast (2.4.1)
-    concurrent-ruby (1.1.10)
-    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.12.0)
-      concurrent-ruby (~> 1.0)
-    minitest (5.16.3)
-    oj (3.11.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (0.93.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.5)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.44.1)
-      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)
-    thread_safe (0.3.6)
-    tins (1.29.1)
-      sync
-    tzinfo (1.2.10)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bright_serializer!
-  bundler (~> 2)
-  coveralls_reborn
-  faker
-  oj
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop
-  rubocop-performance
-  rubocop-rspec
-
-BUNDLED WITH
-   2.2.3

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bright_serializer.gemspec

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bright_serializer/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'bright_serializer'
-  spec.version       = BrightSerializer::VERSION
-  spec.authors       = ['Jean-Francis Bastien']
-  spec.email         = ['jfbastien@petalmd.com']
-
-  spec.summary       = 'Light and fast Ruby serializer'
-  spec.description   = 'BrightSerializer is a minimalist implementation serializer for Ruby objects.'
-  spec.homepage      = 'https://github.com/petalmd/bright_serializer'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.6'
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/petalmd/bright_serializer'
-    spec.metadata['changelog_uri'] = 'https://github.com/petalmd/bright_serializer/blob/master/CHANGELOG.md'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'oj', '~> 3'
-  spec.add_dependency 'activesupport', '>= 5.2'
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'faker', '~> 2'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end