surrealist 1.3.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1442bb3902c4cc204433160a3ae4d079eb5dc017b7e334bf4e5295dbd9a80dd1
-  data.tar.gz: 1801f742b22ffb29bc1dd274506e9b586d56d083f1c66563af9543fe91dd3eba
+  metadata.gz: 0a95bb3a7fc605daa57ca534526272f1b07c213955a27d3e0ece8aed665feb01
+  data.tar.gz: 2a7a0506b60272f0c4e48fd05ccf2ec3f7ca26ae48ad02fab3228fe654b8cfa0
 SHA512:
-  metadata.gz: 02d1b2eb290eee36a0680da61d928ea8a2e0a5ec06da975dbff4439747576bc7147dfe0c80c1722ea1769895996c992c63a960bef19abb9555d2233cab99a7e7
-  data.tar.gz: f3aa6d613311fa504d380b8ad3ce1909a1d0b77353187d4575e0405cae6f5b306782aa3a563fc46b858eb06f6795cd0c2a275b156a0757a441a53eb56e469ee7
+  metadata.gz: ead5a826a27d9947b642e4e0a1119798899df0d2fb9868b171e15219551fb7934fae2d0e628091ec22b17706ab447e9d0c90cd1e523fa859034b28f31a1b5520
+  data.tar.gz: 2db98f48230a322fc153f787cb33b4486c796473b9ceb653eb75a703624a35ca2e1b7ad72457bcd16533ef07f516c53c1ff984d81f0e7d22cbcb6c66909999ba

data/.rubocop.yml

@@ -1,27 +1,29 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - './gemfiles/*gemfile'
     - './tmp/*'
 
-Documentation:
+Style/Documentation:
   Exclude:
     - benchmarks/*rb
     - spec/**/*rb
 
 #  Layout
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: true
 
 Layout/EmptyLineBetweenDefs:
   Exclude:
     - spec/**/*rb
 
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
 Layout/MultilineMethodCallIndentation:
@@ -36,6 +38,10 @@ Layout/SpaceInLambdaLiteral:
 Layout/ClosingParenthesisIndentation:
   Enabled: true
 
+Layout/LineLength:
+  Exclude: [ benchmarks/*rb ]
+  Max: 110
+
 # Lint
 Lint/AmbiguousBlockAssociation:
   Enabled: false
@@ -52,6 +58,19 @@ Lint/NonLocalExitFromIterator:
 Lint/RescueType:
   Enabled: true
 
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*rb
+
+Lint/EmptyClass:
+  Enabled: false
+
+Lint/SymbolConversion:
+  Enabled: false
+
 # Metrics
 
 Metrics/BlockLength:
@@ -65,10 +84,6 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Max: 15
 
-Metrics/LineLength:
-  Exclude: [benchmarks/*rb]
-  Max: 110
-
 Metrics/PerceivedComplexity:
   Enabled: false
 
@@ -81,20 +96,9 @@ Naming/AccessorMethodName:
   Enabled: false
 
 Naming/PredicateName:
-  NamePrefixBlacklist:
+  ForbiddenPrefixes:
     - is_
 
-# Performance
-
-Performance/Caller:
-  Enabled: true
-
-Performance/Casecmp:
-  Enabled: true
-
-Performance/UnfreezeString:
-  Enabled: true
-
 # Style
 
 # ¯\_(ツ)_/¯
@@ -163,9 +167,10 @@ Style/TrailingCommaInHashLiteral:
 Style/MissingRespondToMissing:
   Enabled: false
 
-Style/MethodMissingSuper:
-  Enabled: false
-
 Style/EvalWithLocation:
   Exclude:
     - spec/**/*.rb
+
+Style/ClassVars:
+  Enabled: false
+

data/.travis.yml

@@ -5,14 +5,12 @@ script: bundle exec rake
 matrix:
   fast_finish: true
   include:
-    - rvm: ruby-head
+    - rvm: 3.0
+      gemfile: Gemfile
+    - rvm: 2.7
       gemfile: Gemfile
     - rvm: 2.6
       gemfile: Gemfile
     - rvm: 2.5
-      gemfile: Gemfile
-    - rvm: 2.4
-      gemfile: Gemfile
-    - rvm: 2.3
       gemfile: gemfiles/activerecord42.gemfile
 

data/Gemfile

@@ -4,17 +4,17 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'active_model_serializers', '~> 0.10.0'
+  gem 'active_model_serializers', '~> 0.10'
   gem 'activerecord'
   gem 'benchmark-ips'
   gem 'blueprinter'
   gem 'coveralls', require: false
   gem 'dry-struct'
   gem 'dry-types'
-  gem 'rom', '~> 4.0'
+  gem 'rom', '~> 5.0'
   gem 'rom-repository'
   gem 'rom-sql'
   gem 'sequel'
-  gem 'sqlite3', '~> 1.4.1'
+  gem 'sqlite3', '~> 1.4'
   gem 'yard', require: false unless ENV['TRAVIS']
 end

data/README.md

@@ -497,10 +497,10 @@ class Car
 
   json_schema do
     {
-      age:            Types::Coercible::Int,
+      age:            Types::Coercible::Integer,
       brand:          Types::Coercible::String,
-      doors:          Types::Int.optional,
-      horsepower:     Types::Strict::Int.constrained(gteq: 20),
+      doors:          Types::Integer.optional,
+      horsepower:     Types::Strict::Integer.constrained(gteq: 20),
       fuel_system:    Types::Any,
       previous_owner: Types::String,
     }

data/Rakefile

@@ -2,7 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/benchmarks/surrealist_vs_ams.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+# rubocop:disable Metrics/MethodLength
 require_relative '../lib/surrealist'
 require 'benchmark/ips'
 require 'active_record'
@@ -36,7 +36,7 @@ end
 ActiveModelSerializers.config.adapter = :json
 
 def random_name
-  ('a'..'z').to_a.shuffle.join('').first(10).capitalize
+  ('a'..'z').to_a.shuffle.join.first(10).capitalize
 end
 
 class User < ActiveRecord::Base
@@ -304,4 +304,4 @@ benchmark_associations_collection
 #   Surrealist (associations): collection through Surrealist.surrealize_collection():        2.4 i/s
 #   Surrealist (associations): collection through Surrealist::Serializer:        2.4 i/s - 1.03x  slower
 #   AMS (associations): collection:        1.5 i/s - 1.60x  slower
-# rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+# rubocop:enable Metrics/MethodLength

data/gemfiles/activerecord42.gemfile

@@ -7,7 +7,7 @@ group :development, :test do
   gem 'coveralls', require: false
   gem 'dry-struct'
   gem 'dry-types'
-  gem 'rom', '~> 3.0'
+  gem 'rom', '~> 5.0'
   gem 'rom-repository'
   gem 'rom-sql'
   gem 'sequel'

data/lib/surrealist/carrier.rb

@@ -22,7 +22,7 @@ module Surrealist
     #
     # @return [Carrier] self if type checks were passed.
     def self.call(**args)
-      new(args).sanitize!
+      new(**args).sanitize!
     end
 
     def initialize(**args)

data/lib/surrealist/hash_utils.rb

@@ -15,7 +15,7 @@ module Surrealist
         return hash unless hash.is_a?(Hash)
 
         hash.each_with_object({}) do |(k, v), obj|
-          obj[camelize_key(k, false)] = camelize_hash(v)
+          obj[camelize_key(k, first_upper: false)] = camelize_hash(v)
         end
       end
 
@@ -27,11 +27,12 @@ module Surrealist
       # @param [Boolean] first_upper should the first letter be capitalized.
       #
       # @return [String | Symbol] camelized key of a hash.
-      def camelize_key(key, first_upper = true)
-        if key.is_a? Symbol
-          Surrealist::StringUtils.camelize(key.to_s, first_upper).to_sym
-        elsif key.is_a? String
-          Surrealist::StringUtils.camelize(key, first_upper)
+      def camelize_key(key, first_upper: true)
+        case key
+        when Symbol
+          Surrealist::StringUtils.camelize(key.to_s, first_upper: first_upper).to_sym
+        when String
+          Surrealist::StringUtils.camelize(key, first_upper: first_upper)
         else
           key
         end

data/lib/surrealist/instance_methods.rb

@@ -49,10 +49,10 @@ module Surrealist
     #   # => "{\"name\":\"Nikita\",\"age\":23}"
     #   # For more examples see README
     def surrealize(**args)
-      return args[:serializer].new(self).surrealize(args) if args[:serializer]
+      return args[:serializer].new(self).surrealize(**args) if args[:serializer]
 
       if (serializer = find_serializer(args[:for]))
-        return serializer.new(self).surrealize(args)
+        return serializer.new(self).surrealize(**args)
       end
 
       Oj.dump(Surrealist.build_schema(instance: self, **args), mode: :compat)
@@ -60,10 +60,10 @@ module Surrealist
 
     # Invokes +Surrealist+'s class method +build_schema+
     def build_schema(**args)
-      return args[:serializer].new(self).build_schema(args) if args[:serializer]
+      return args[:serializer].new(self).build_schema(**args) if args[:serializer]
 
       if (serializer = find_serializer(args[:for]))
-        return serializer.new(self).build_schema(args)
+        return serializer.new(self).build_schema(**args)
       end
 
       Surrealist.build_schema(instance: self, **args)

data/lib/surrealist/serializer.rb

@@ -81,7 +81,7 @@ module Surrealist
     # Checks whether object is a collection or an instance and serializes it
     def surrealize(**args)
       if Helper.collection?(object)
-        Surrealist.surrealize_collection(object, args.merge(context: context))
+        Surrealist.surrealize_collection(object, **args.merge(context: context))
       else
         Surrealist.surrealize(instance: self, **args)
       end
@@ -90,7 +90,7 @@ module Surrealist
     # Passes build_schema to Surrealist
     def build_schema(**args)
       if Helper.collection?(object)
-        build_collection_schema(args)
+        build_collection_schema(**args)
       else
         Surrealist.build_schema(instance: self, **args)
       end
@@ -102,7 +102,7 @@ module Surrealist
 
     # Maps collection and builds schema for each instance.
     def build_collection_schema(**args)
-      object.map { |object| self.class.new(object, context).build_schema(args) }
+      object.map { |object| self.class.new(object, **context).build_schema(**args) }
     end
 
     # Methods not found inside serializer will be invoked on the object

data/lib/surrealist/string_utils.rb

@@ -33,7 +33,7 @@ module Surrealist
       # @param [Boolean] first_upper should the first letter be capitalized.
       #
       # @return [String] camelized string.
-      def camelize(snake_string, first_upper = true)
+      def camelize(snake_string, first_upper: true)
         if first_upper
           snake_string.to_s.gsub(UNDERSCORE_REGEXP) { Regexp.last_match[1].capitalize }
         else
@@ -73,7 +73,7 @@ module Surrealist
         Surrealist::ExceptionRaiser.raise_invalid_nesting!(nesting_level) unless nesting_level.positive?
 
         klass.split(NAMESPACES_SEPARATOR).last(nesting_level).reverse!.inject({}) do |a, n|
-          key = (camelize ? camelize(uncapitalize(n), false) : underscore(n)).to_sym
+          key = (camelize ? camelize(uncapitalize(n), first_upper: false) : underscore(n)).to_sym
 
           { key => a }
         end

data/lib/surrealist/version.rb

@@ -2,5 +2,5 @@
 
 module Surrealist
   # Defines the version of Surrealist
-  VERSION = '1.3.4'
+  VERSION = '2.0.0'
 end

data/lib/surrealist/wrapper.rb

@@ -11,8 +11,8 @@ module Surrealist
       # @param [String] klass instance's class name.
       #
       # @return [Hash] a wrapped hash.
-      def wrap(hash, carrier, klass = false)
-        namespaces_condition = carrier.include_namespaces || carrier.namespaces_nesting_level != DEFAULT_NESTING_LEVEL # rubocop:disable Metrics/LineLength
+      def wrap(hash, carrier, klass: false)
+        namespaces_condition = carrier.include_namespaces || carrier.namespaces_nesting_level != DEFAULT_NESTING_LEVEL # rubocop:disable Layout/LineLength
 
         if !klass && (carrier.include_root || namespaces_condition)
           Surrealist::ExceptionRaiser.raise_unknown_root!
@@ -56,7 +56,7 @@ module Surrealist
       # @return [Hash] a hash with schema wrapped inside a root key.
       def wrap_schema_into_root(schema, carrier, root)
         root_key = if carrier.camelize
-                     Surrealist::StringUtils.camelize(root, false).to_sym
+                     Surrealist::StringUtils.camelize(root, first_upper: false).to_sym
                    else
                      Surrealist::StringUtils.underscore(root).to_sym
                    end

data/lib/surrealist.rb

@@ -59,7 +59,7 @@ module Surrealist
       Surrealist::ExceptionRaiser.raise_invalid_collection! unless Helper.collection?(collection)
 
       result = collection.map do |object|
-        Helper.surrealist?(object.class) ? __build_schema(object, args) : object
+        Helper.surrealist?(object.class) ? __build_schema(object, **args) : object
       end
 
       args[:raw] ? result : Oj.dump(result, mode: :compat)
@@ -128,13 +128,13 @@ module Surrealist
       schema = Surrealist::VarsHelper.find_schema(instance.class)
       Surrealist::ExceptionRaiser.raise_unknown_schema!(instance) if schema.nil?
 
-      parameters = config ? config.merge(args) : args
+      parameters = config ? config.merge(**args) : args
 
       # TODO: Refactor (something pipeline-like would do here, perhaps a builder of some sort)
-      carrier = Surrealist::Carrier.call(parameters)
+      carrier = Surrealist::Carrier.call(**parameters)
       copied_schema = Surrealist::Copier.deep_copy(schema)
       built_schema = Builder.new(carrier, copied_schema, instance).call
-      wrapped_schema = Surrealist::Wrapper.wrap(built_schema, carrier, instance.class.name)
+      wrapped_schema = Surrealist::Wrapper.wrap(built_schema, carrier, klass: instance.class.name)
       carrier.camelize ? Surrealist::HashUtils.camelize_hash(wrapped_schema) : wrapped_schema
     end
     # rubocop:enable Metrics/AbcSize
@@ -178,10 +178,10 @@ module Surrealist
     #   provided in the object's class. Values will be taken from the return values
     #   of appropriate methods from the object.
     def __build_schema(object, **args)
-      return args[:serializer].new(object, args[:context].to_h).build_schema(args) if args[:serializer]
+      return args[:serializer].new(object, **args[:context].to_h).build_schema(**args) if args[:serializer]
 
       if (serializer = Surrealist::VarsHelper.find_serializer(object.class, tag: args[:for]))
-        serializer.new(object, args[:context].to_h).build_schema(args)
+        serializer.new(object, **args[:context].to_h).build_schema(**args)
       else
         build_schema(instance: object, **args)
       end

data/surrealist.gemspec

@@ -22,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_runtime_dependency 'oj', '~> 3.0'
+  spec.add_runtime_dependency 'oj', '~> 3.11'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry', '~> 0.12'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.66'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrealist
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Nikita Esaulov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-18 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '1.9'
 description: A gem that provides DSL for serialization of plain old Ruby objects to
   JSON in a declarative style by defining a `schema`. It also provides a trivial type
   checking in the runtime before serialization.
@@ -143,7 +143,7 @@ homepage: https://github.com/nesaulov/surrealist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,15 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A gem that provides DSL for serialization of plain old Ruby objects to JSON
   in a declarative style.