mutils 0.2.37 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926c4b4de85c53430599d8d3f0bedc06992bba7475f5bfb63c17c0149b9f5e7c
-  data.tar.gz: 510912f1df040bb65dc4b13d92c7e1e9c3cd976bd29a089dd87449bae7a58813
+  metadata.gz: 3bae9a5bf148506da670aefb73cdd40696249e3c4b333730cb9be09f2a1bf175
+  data.tar.gz: c54e0b03b2e04278fa5ed591b9143b8e1f18cc25645b602cc7a8e5b92d92da61
 SHA512:
-  metadata.gz: 93232e13da63e6c1dd76a44e0bbce37a0fd0ef030bca6b099c47e8529e4ea4522edcf0b5aaca07c19e9aaba9cf0c9febbfceef651544aadbf5170395c444dd64
-  data.tar.gz: d9fdd7f409e3c7d9dde57ed7a59504aca0145c2dc93f054cd9a6e75b390940f111fb827e352c7510b46864f37175abd266b0f40407b9c4414e6207cdd1baca75
+  metadata.gz: 7d345ab04715eeda889499df8e943cb1862db55117cc65000ed67b4a7899ae5ad87218bf3f0f620e6a32871a5ce4036223fe7e9fd10f40a8d26e16248718d9ec
+  data.tar.gz: be915ee7e6361dd88226e68aea8c7bbc280f360c23229493611efa561dcd20d0d3be4d578cb62d343d862e773d80cd55da09bfe77765e683fc08e6c0d67e50b1

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 .idea/*
 *.gem
+/node_modules

data/.huskyrc

@@ -0,0 +1,7 @@
+{
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  }
+}

data/.rspec

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

data/.rubocop.yml

@@ -4,5 +4,4 @@ AllCops:
   TargetRubyVersion: "2.5.0"
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
-    - 'benchmark/benchmark-serializer-json.rb'
+    - 'test/**/*'

data/.rubocop_todo.yml

@@ -37,6 +37,8 @@ Layout/LineLength:
   Max: 608
 Metrics/MethodLength:
   Max: 20
+Metrics/PerceivedComplexity:
+  Max: 7
 Metrics/AbcSize:
   Max: 22
 Style/HashEachMethods:

data/.travis.yml

@@ -12,7 +12,18 @@ cache: bundler
 before_install:
   - gem install bundler -v 2.0.1
   - gem install rspec
-script: bundle exec rspec
+  - nvm use 11
+  - npm install
+script: bundle exec rubocop lib && bundle exec rspec
 branches:
   only: master
-bundler_args: --with=development,test --jobs=3 --retry=3
+bundler_args: --with=development,test --jobs=3 --retry=3
+jobs:
+  include:
+    - stage: release
+      rvm: 2.6.5
+      script: npx semantic-release
+stages:
+  - test
+  - name: release
+    if: (NOT type IN (pull_request)) AND (branch = master)

data/CHANGELOG.md

@@ -1,6 +1,45 @@
-# Changelog
+## [1.1.2](https://github.com/Code-Vedas/mutils/compare/v1.1.1...v1.1.2) (2020-10-15)
 
-## [v0.2.36](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-14)
+
+### Bug Fixes
+
+* **coveralls:** gemfile to reduce vulnerabilities ([#64](https://github.com/Code-Vedas/mutils/issues/64)) ([7d4e592](https://github.com/Code-Vedas/mutils/commit/7d4e59214d5c9aced1c4beb1a6b9f929367d84da))
+
+## [1.1.1](https://github.com/Code-Vedas/mutils/compare/v1.1.0...v1.1.1) (2020-10-05)
+
+
+### Bug Fixes
+
+* **params:** always send hash in params ([7d71b6d](https://github.com/Code-Vedas/mutils/commit/7d71b6d2c89f39883745a40e5472c444b5673e8b))
+
+# [1.1.0](https://github.com/Code-Vedas/mutils/compare/v1.0.1...v1.1.0) (2020-08-15)
+
+
+### Features
+
+* **params:** conditional if:Proc get params as second attribute ([55a3b08](https://github.com/Code-Vedas/mutils/commit/55a3b08fee52c0dbef2b22c6e4f468389f8c53a4))
+
+## [1.0.1](https://github.com/Code-Vedas/mutils/compare/v1.0.0...v1.0.1) (2020-07-24)
+
+
+### Bug Fixes
+
+* **semantic-release:** enable semantic-release ([aa9c28f](https://github.com/Code-Vedas/mutils/commit/aa9c28fb8da7fcd1915a189bda22f8421a566eee))
+
+## [1.0.0](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-17)
+
+[Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.36...v1.0.0)
+
+**First Stable release: Features**
+- Performance upto 35i/s under load
+- Observed 35-40 MB of memory usage
+- Fully featured JSON serializer similar to Active Serializer but with more power and speed.
+ 
+**Changes:**
+- Code refactored 
+- Using cache for expensive operations
+
+## [0.2.36](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-14)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.35...v0.2.36)
 
@@ -10,7 +49,7 @@
 - Conditional attributes and relations [\#32](https://github.com/code-vedas/mutils/pull/32) ([niteshpurohit](https://github.com/niteshpurohit))
 - chore: add more ruby version and os to test [\#31](https://github.com/code-vedas/mutils/pull/31) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.35](https://github.com/code-vedas/mutils/tree/v0.2.35) (2020-03-30)
+## [0.2.35](https://github.com/code-vedas/mutils/tree/v0.2.35) (2020-03-30)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.34...v0.2.35)
 
@@ -20,7 +59,7 @@
 - added custom\_method and attribute example [\#29](https://github.com/code-vedas/mutils/pull/29) ([niteshpurohit](https://github.com/niteshpurohit))
 - chore: update changelog [\#28](https://github.com/code-vedas/mutils/pull/28) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.34](https://github.com/code-vedas/mutils/tree/v0.2.34) (2020-03-29)
+## [0.2.34](https://github.com/code-vedas/mutils/tree/v0.2.34) (2020-03-29)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.33...v0.2.34)
 
@@ -28,7 +67,7 @@
 
 - Feature/attribute can be optional [\#27](https://github.com/code-vedas/mutils/pull/27) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.33](https://github.com/code-vedas/mutils/tree/v0.2.33) (2020-03-29)
+## [0.2.33](https://github.com/code-vedas/mutils/tree/v0.2.33) (2020-03-29)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.32...v0.2.33)
 
@@ -39,7 +78,7 @@
 - Create .codeclimate.yml [\#24](https://github.com/code-vedas/mutils/pull/24) ([niteshpurohit](https://github.com/niteshpurohit))
 - changelog: v0.2.32 [\#22](https://github.com/code-vedas/mutils/pull/22) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.32](https://github.com/code-vedas/mutils/tree/v0.2.32) (2020-03-18)
+## [0.2.32](https://github.com/code-vedas/mutils/tree/v0.2.32) (2020-03-18)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.31...v0.2.32)
 
@@ -47,7 +86,7 @@
 
 - Feature/improve performance [\#21](https://github.com/code-vedas/mutils/pull/21) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.31](https://github.com/code-vedas/mutils/tree/v0.2.31) (2020-03-18)
+## [0.2.31](https://github.com/code-vedas/mutils/tree/v0.2.31) (2020-03-18)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.30...v0.2.31)
 
@@ -56,7 +95,7 @@
 - Update version.rb [\#20](https://github.com/code-vedas/mutils/pull/20) ([niteshpurohit](https://github.com/niteshpurohit))
 - Rake 13.0 [\#19](https://github.com/code-vedas/mutils/pull/19) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.30](https://github.com/code-vedas/mutils/tree/v0.2.30) (2020-03-17)
+## [0.2.30](https://github.com/code-vedas/mutils/tree/v0.2.30) (2020-03-17)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.29...v0.2.30)
 
@@ -64,7 +103,7 @@
 
 - Deps [\#18](https://github.com/code-vedas/mutils/pull/18) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.29](https://github.com/code-vedas/mutils/tree/v0.2.29) (2019-12-07)
+## [0.2.29](https://github.com/code-vedas/mutils/tree/v0.2.29) (2019-12-07)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.28...v0.2.29)
 
@@ -72,7 +111,7 @@
 
 - Scope Variable bug [\#14](https://github.com/code-vedas/mutils/pull/14) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.28](https://github.com/code-vedas/mutils/tree/v0.2.28) (2019-11-26)
+## [0.2.28](https://github.com/code-vedas/mutils/tree/v0.2.28) (2019-11-26)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.27...v0.2.28)
 
@@ -80,7 +119,7 @@
 
 - Feature/scoped generator [\#13](https://github.com/code-vedas/mutils/pull/13) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.27](https://github.com/code-vedas/mutils/tree/v0.2.27) (2019-11-25)
+## [0.2.27](https://github.com/code-vedas/mutils/tree/v0.2.27) (2019-11-25)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.26...v0.2.27)
 
@@ -97,11 +136,11 @@
 - Update README.md [\#7](https://github.com/code-vedas/mutils/pull/7) ([niteshpurohit](https://github.com/niteshpurohit))
 - Update README.md [\#6](https://github.com/code-vedas/mutils/pull/6) ([niteshpurohit](https://github.com/niteshpurohit))
 
-## [v0.2.26](https://github.com/code-vedas/mutils/tree/v0.2.26) (2019-11-24)
+## [0.2.26](https://github.com/code-vedas/mutils/tree/v0.2.26) (2019-11-24)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/v0.2.25...v0.2.26)
 
-## [v0.2.25](https://github.com/code-vedas/mutils/tree/v0.2.25) (2019-11-24)
+## [0.2.25](https://github.com/code-vedas/mutils/tree/v0.2.25) (2019-11-24)
 
 [Full Changelog](https://github.com/code-vedas/mutils/compare/885f96959dd3701ac20ed0981b920be753c00db0...v0.2.25)
 
@@ -109,6 +148,3 @@
 
 - Feature/improve concurrency [\#4](https://github.com/code-vedas/mutils/pull/4) ([niteshpurohit](https://github.com/niteshpurohit))
 - Testing Deploy [\#3](https://github.com/code-vedas/mutils/pull/3) ([niteshpurohit](https://github.com/niteshpurohit))
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -3,4 +3,10 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mutils.gemspec
+gem 'coveralls'
+gem 'pre-commit', require: false
+gem 'rspec'
+gem 'rspec-benchmark'
+gem 'rspec-json_expectations'
+gem 'rubocop'
 gemspec

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    mutils (0.2.36)
+    mutils (1.1.1)
       dry-inflector
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
+    benchmark-malloc (0.2.0)
+    benchmark-perf (0.6.0)
+    benchmark-trend (0.4.0)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -18,11 +22,25 @@ GEM
     dry-inflector (0.2.0)
     json (2.3.0)
     json (2.3.0-java)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pluginator (1.5.0)
+    pre-commit (0.39.0)
+      pluginator (~> 1.5)
+    rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
+    rspec-benchmark (0.6.0)
+      benchmark-malloc (~> 0.2)
+      benchmark-perf (~> 0.6)
+      benchmark-trend (~> 0.4)
+      rspec (>= 3.0)
     rspec-core (3.9.1)
       rspec-support (~> 3.9.1)
     rspec-expectations (3.9.1)
@@ -33,6 +51,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -44,6 +74,7 @@ GEM
     thor (1.0.1)
     tins (1.24.1)
       sync
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   java
@@ -53,9 +84,12 @@ DEPENDENCIES
   bundler (~> 2.0)
   coveralls
   mutils!
+  pre-commit
   rake (~> 13.0)
   rspec
+  rspec-benchmark
   rspec-json_expectations
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -26,7 +26,7 @@ These collection of modules are built by developer for developers :-)
 
 ## Features
 * Simple declaration syntax similar to Active Model Serializer
-* Realtionships support `belongs_to', `has_many`, `has_one`
+* Realtionships support `belongs_to`, `has_many`, `has_one`
 * Block style attributes with params
 
 ## Installation
@@ -89,7 +89,7 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name, :email
   
   belongs_to :company, serializer: CompanySerializer, always_include: true
-  ##OR
+  ## OR
   belongs_to :company, serializer: CompanySerializer, always_include: true, label: 'organization'   ##<== important to give singular name
   
   has_many :comments, serializer: CommentSerializer
@@ -101,7 +101,11 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
 end
 ```
 ### Conditional Attributes
-Attributes are fields in the model itself. You can reference them by below example
+Serializer can have conditional attributes with `if: Proc` 
+`if: Proc` block can receive `scope` and `params` as arguments
+
+- __in proc {|scope|}__, scope is object which is being serialized
+- __in proc {|scope,params|}__, scope is object which is being serialized and params is hash given to Serializer as second arguments in {params:anything}
 ```ruby
 # frozen_string_literal: true
 
@@ -109,11 +113,20 @@ Attributes are fields in the model itself. You can reference them by below examp
 class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name
   attribute :email, if: proc { |scope| scope.name == 'mutils' } ## Email will only serialize if user's name is 'mutils'
+  # OR with Params
+  attribute :email, if: proc { |scope,params| params && params[:show_email] == true } ## Email will only serialize if params[:show_email] is true
 end
+
+UserSerializer.new(user) # Without params
+UserSerializer.new(user,{params:{show_email:true}}) # With params
 ```
-    in proc {|scope|}, scope is object which is being serialized
+
 ### Conditional Relations
-Attributes are fields in the model itself. You can reference them by below example
+Serializer can have conditional relations with `if: Proc` 
+`if: Proc` block can receive `scope` and `params` as arguments
+
+- __in proc {|scope|}__, scope is object which is being serialized
+- __in proc {|scope,params|}__, scope is object which is being serialized and params is hash given to Serializer as second arguments in {params:anything}
 ```ruby
 # frozen_string_literal: true
 
@@ -122,9 +135,15 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name
   has_many :comments, serializer: CommentSerializer, if: proc { |scope| scope.name == 'mutils' } ## comments will only serialize if user's name is 'mutils'
   belongs_to :account, serializer: AccountSerializer, if: proc { |scope| scope.name != 'mutils' } ## account will only serialize if user's name is not 'mutils'
+  # OR with Params
+  belongs_to :account, serializer: AccountSerializer, if: proc { |scope,params| params && params[:show_account] == true } ## account will only serialize if params[:show_account] is true
 end
+
+UserSerializer.new(user) # Without params
+UserSerializer.new(user,{params:{show_account:true}}) # With params
+
 ```
-    in proc {|scope|}, scope is object which is being serialized    
+    
 ### Attributes Blocks
 While writting attribute a block can be provided for useful transformations like `full_name` as shown below
 ```ruby
@@ -209,13 +228,13 @@ user = User.first
 options = {includes: [:comments,:account]}
 UserSerializer.new(user,options).to_h
 ```
-###or
+### or
 ```ruby
 users = User.all
 options = {includes: [:account]}
 UserSerializer.new(users,options).to_json
 ```
-###or in controllers
+### or in controllers
 ```ruby
 users = User.all
 options = {includes: [:account]}
@@ -234,3 +253,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Mutils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/code-vedas/mutils/blob/master/CODE_OF_CONDUCT.md).
+
+## Security
+
+For security refer to [security](https://github.com/Code-Vedas/mutils/blob/master/SECURITY.md) document.

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Versions currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Create an issue or email at security@codevedas.com

data/Version

@@ -0,0 +1 @@
+v1.1.2

data/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-angular']};

data/gemdeploy.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -euo pipefail
+
+mkdir -p $HOME/.gem
+touch $HOME/.gem/credentials
+chmod 0600 $HOME/.gem/credentials
+printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+gem build *.gemspec
+gem push *.gem

data/lib/mutils.rb

@@ -3,6 +3,7 @@
 require 'dry/inflector'
 require_relative 'mutils/version'
 require_relative 'mutils/lib/helper'
+require_relative 'mutils/lib/result_hash'
 require_relative 'mutils/serialization/serialization_results'
 require_relative 'mutils/serialization/serialization_includes'
 require_relative 'mutils/serialization/serialization_methods'