mutils 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e38e7ca1f83b872f6a72819355f44ef30a1de7b6c3756abd27e3ec66e256b90a
-  data.tar.gz: a3267a83c8a82770d84f7636f3f8b19aa5039eabcfc6b2953b605981d21e1d6b
+  metadata.gz: 4af2ef0147adcbbbd24128d3af1214bad8f13c379f8ec411a11691e11dc8010b
+  data.tar.gz: fdb0af64961644ac7b433e8c24de95895ac62a8da7f638b6cda52042ce44956c
 SHA512:
-  metadata.gz: 2a423ea8de2ccf77982fdfec8a9dd9b164a42b0da5b2aa4664889d1e13bae2eba384344bc25c7a24ec8267218a98170c0f7b92c7695926cb72a8b2d6ad695d9b
-  data.tar.gz: 3f1f7b51833b2cb57d8ad2da72aebbca7799ac9f86f61380ab2a9cce5af15bc642591fe5b483d78054a37b4e9ff8b5cbcfe4776537bd8c7da650b83a8ba59679
+  metadata.gz: '008315c5d7101af58c4c5efd49e555f962d33097f25b3aef286a96b941025b761e55f644a13fe6776d831cd9c2f7bbd0da0edb6d2e49700b513c94db06e0a6ed'
+  data.tar.gz: 2b049ce4370955401074e41a970fbdd1f4921d211860cb1d82491815118ce937678f0f8650e90e8fde4bc5f34fc60f81681886a615f1269848ec400ffdf4dbe0

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/.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,5 +1,39 @@
-# Changelog
-## [v1.0.0](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-17)
+## [1.1.3](https://github.com/Code-Vedas/mutils/compare/v1.1.2...v1.1.3) (2020-10-18)
+
+
+### Bug Fixes
+
+* Gemfile to reduce vulnerabilities ([#65](https://github.com/Code-Vedas/mutils/issues/65)) ([49b5ae2](https://github.com/Code-Vedas/mutils/commit/49b5ae2ba795d16976425ddbaf1e1c372a940c1f))
+
+## [1.1.2](https://github.com/Code-Vedas/mutils/compare/v1.1.1...v1.1.2) (2020-10-15)
+
+
+### 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)
 
@@ -12,7 +46,7 @@
 - Code refactored 
 - Using cache for expensive operations
 
-## [v0.2.36](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-14)
+## [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)
 
@@ -22,7 +56,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)
 
@@ -32,7 +66,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)
 
@@ -40,7 +74,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)
 
@@ -51,7 +85,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)
 
@@ -59,7 +93,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)
 
@@ -68,7 +102,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)
 
@@ -76,7 +110,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)
 
@@ -84,7 +118,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)
 
@@ -92,7 +126,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)
 
@@ -109,15 +143,15 @@
 - 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)
 
 **Merged pull requests:**
 
 - 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))
+- Testing Deploy [\#3](https://github.com/code-vedas/mutils/pull/3) ([niteshpurohit](https://github.com/niteshpurohit))

data/Gemfile

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

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    mutils (1.0.0)
+    mutils (1.1.2)
       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)
@@ -21,7 +22,16 @@ 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)
@@ -41,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)
@@ -52,6 +74,7 @@ GEM
     thor (1.0.1)
     tins (1.24.1)
       sync
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   java
@@ -59,12 +82,14 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  coveralls
+  coveralls (>= 0.8.23)
   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.3

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/serialization/results/attributes.rb

@@ -9,7 +9,7 @@ module Mutils
       module Attributes
         def fetch_block_attributes(attributes, result_hash)
           attributes&.each do |key, s_options|
-            result_hash[key] = s_options[:block].call(scope, options[:params])
+            result_hash[key] = s_options[:block].call(scope, options[:params] || {})
           end
         end
 

data/lib/mutils/serialization/results/main.rb

@@ -29,7 +29,7 @@ module Mutils
         end
 
         def check_if_included(s_options, key)
-          return s_options[:if].call(scope) unless s_options[:if].nil? || scope_is_collection?
+          return s_options[:if].call(scope, options[:params] || {}) unless s_options[:if].nil? || scope_is_collection?
 
           s_options[:always_include] || options[:includes]&.include?(key)
         end

data/lib/mutils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mutils
-  VERSION = '1.0.0'
+  VERSION = File.read('Version').split("\n").first.gsub('v', '')
 end

data/mutils.gemspec

@@ -24,11 +24,8 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = '>= 1.8.11'
   spec.add_dependency('dry-inflector')
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec-benchmark'
-  spec.add_development_dependency 'rspec-json_expectations'
+
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/code-vedas/mutils/issues',