mutils 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f4f22ec41acc086cbafa8faf65e178225d09ea7db26063cf79b573e73414dcf
-  data.tar.gz: cf6d77090e3bcf778256c06ff4e420d7fd8d80e3c53c3f2452bf46af2cb980d6
+  metadata.gz: 98a4047fe721fbd198edb5e606223a3699ba2222d0f6319b634615f875320068
+  data.tar.gz: 286e141ad7ddf09093e172d7ed218029e37799ffbf75bb2a810ffd6bd35560d0
 SHA512:
-  metadata.gz: '099ca4359d53e79a80b28f9fe46213d21900719e177e415c0bd22ff41c01f78014ae15e1cf7e54d0202184e193d4a814c8bdf68a28de66391b0c831e4fbac1c1'
-  data.tar.gz: a74375db4eba7aedc14f598faebf8dfd6e0851a91218a96cbb7f88373924d6409037617ac7a10e82102f9eb31e944b0e35e02424e1261fa4ad0057acac61315c
+  metadata.gz: 7a20addb48d632c80dea073b0265dbfda78f94afa084bcdb2c87db0eabb7aaa05792e8e458250c3f7e18145189867fc3b40a3fd21ccf36cc613894cc8081a818
+  data.tar.gz: 868e8a0399312495e8cc427b98681644dc9bac978d3c5489470cc9d302a70386b6a874a5c18c2b4066e86b0ba294d74f5e7d0273816bf3cdbaf0580128ccbf22

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2019 Nitesh Purohit
+Copyright (c) 2019-present Codevedas Inc. and the Mutils Authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,51 +1,62 @@
+# Mutils
+
 [![Maintainability](https://api.codeclimate.com/v1/badges/42e8a34f839ca0c5ec45/maintainability)](https://codeclimate.com/github/code-vedas/mutils/maintainability)
-![](https://ruby-gem-downloads-badge.herokuapp.com/mutils?type=total&color=brightgreen)
+![Ruby gem downloads](https://ruby-gem-downloads-badge.herokuapp.com/mutils?type=total&color=brightgreen)
 [![Gem Version](https://badge.fury.io/rb/mutils.svg)](https://badge.fury.io/rb/mutils)
 [![Coverage Status](https://badge.coveralls.io/repos/github/Code-Vedas/mutils/badge.svg?branch=master)](https://badge.coveralls.io/github/Code-Vedas/mutils?branch=master)
 
-# Mutils
 ## Introduction
-`mutils` is collection of useful modules for `ruby on rails` which is tested and benchmarked against high load.
-
-These collection of modules are built by developer for developers :-)
-# Table of Contents
-
-* [Features](#features)
-* [Installation](#installation)
-* [Usage](#usage)
-  * [Rails Generator](#rails-generator)
-  * [Attributes](#attributes)
-  * [Relations](#relations)
-  * [Conditional Attributes](#conditional-attributes)
-  * [Conditional Relations](#conditional-relations)
-  * [Attributes Block](#attributes-blocks)
-  * [Attributes Block with Params](#attributes-blocks-with-params)
-  * [Custom Methods](#custom-methods)
-  * [Name Tag](#name-tag)
-  * [Sample Usage](#sample-usage)
+
+`mutils` is a collection of useful helpers for Ruby and Rails applications.
+
+Serialization is one of the features available today, and the gem is intended to grow into a broader utility toolkit over time.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Rails Generator](#rails-generator)
+  - [Attributes](#attributes)
+  - [Relations](#relations)
+  - [Conditional Attributes](#conditional-attributes)
+  - [Conditional Relations](#conditional-relations)
+  - [Attributes Block](#attributes-blocks)
+  - [Attributes Block with Params](#attributes-blocks-with-params)
+  - [Custom Methods](#custom-methods)
+  - [Name Tag](#name-tag)
+  - [Sample Usage](#sample-usage)
 
 ## Features
-* Simple declaration syntax similar to Active Model Serializer
-* Realtionships support `belongs_to`, `has_many`, `has_one`
-* Block style attributes with params
+
+- Simple declaration syntax similar to Active Model Serializer
+- Relationships support `belongs_to`, `has_many`, `has_one`
+- Block style attributes with params
 
 ## Installation
 
 Add this line to your application's Gemfile:
+
 ```ruby
 gem 'mutils'
 ```
+
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install mutils
+```bash
+gem install mutils
+```
 
-## Usage 
+## Usage
 
 ### Rails Generator
+
 ```shell script
 rails g mutils:serializer User id first_name last_name email
 
@@ -53,7 +64,9 @@ OUTPUT
 Running via Spring preloader in process xxxxx
       create  app/serializers/user_serializer.rb
 ```
+
 You will get serializer in app/serializers/user_serializer.rb
+
 ```ruby
 # frozen_string_literal: true
 
@@ -64,7 +77,9 @@ end
 ```
 
 ### Attributes
+
 Attributes are fields in the model itself. You can reference them by below example
+
 ```ruby
 # frozen_string_literal: true
 
@@ -77,37 +92,44 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   attribute :email, &:email ## this will call email attribute from User
 end
 ```
+
 ### Relations
+
 Relations such as `has_many`, `belongs_to`, `has_one` can be used as follows
+
 1. Every relation must be provided with their own serializer
 2. `always_include` option can be used to instruct `Serializer` to always include this relation
 3. `always_include` by default is disabled, relations which are not `always_include` can be included while using the serializer. Refer to next section for this usage
 4. `label` option can be used to override model class name while serializing
+
 ```ruby
 # frozen_string_literal: true
 
 # User Serializer
 class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name, :email
-  
+
   belongs_to :company, serializer: CompanySerializer, always_include: true
   ## OR
   belongs_to :company, serializer: CompanySerializer, always_include: true, label: 'organization'   ##<== important to give singular name
-  
+
   has_many :comments, serializer: CommentSerializer
   has_one :account, serializer: AccountSerializer
-  
+
   def full_name
     "#{scope.first_name} #{scope.last_name}"
   end
 end
 ```
+
 ### Conditional Attributes
-Serializer can have conditional attributes with `if: Proc` 
+
+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}
+- **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
 
@@ -124,11 +146,13 @@ UserSerializer.new(user,{params:{show_email:true}}) # With params
 ```
 
 ### Conditional Relations
-Serializer can have conditional relations with `if: Proc` 
+
+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}
+- **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
 
@@ -145,9 +169,11 @@ UserSerializer.new(user) # Without params
 UserSerializer.new(user,{params:{show_account:true}}) # With params
 
 ```
-    
+
 ### Attributes Blocks
-While writting attribute a block can be provided for useful transformations like `full_name` as shown below
+
+While writing attribute a block can be provided for useful transformations like `full_name` as shown below
+
 ```ruby
 # frozen_string_literal: true
 
@@ -159,8 +185,11 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   end
 end
 ```
+
 ### Attributes Blocks with Params
-While writting attribute a block can be provided for useful transformations like `full_name` as shown below
+
+While writing attribute a block can be provided for useful transformations like `full_name` as shown below
+
 ```ruby
 # frozen_string_literal: true
 
@@ -172,6 +201,7 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   end
 end
 ```
+
 ```ruby
 # in controller
 
@@ -179,7 +209,9 @@ user = current_user
 owner = owner_user
 render json: UserSerializer.new(user,{params:{owner:owner}})
 ```
+
 ### Custom Methods
+
 Custom methods used in Serializer can be useful for cases as below.
 `scope` will be available to reference object in Serializer in below case its `user`
 
@@ -193,21 +225,25 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   custom_methods :full_name
   ## OR
   custom_method :full_name, {always_include: true}   ## this will allow to selectively include full_name
-  ### 
-  
+  ###
+
   def full_name
     "#{scope.first_name} #{scope.last_name}"
   end
 end
 ```
+
 ### Name Tag
+
 name_tag is used to provide custom name to serializer output keys for json
 
-**Options**
-  - ``name_tag 'Person', true`` # Include Person or People in JSON serialization as root, true|false this only implies to root serializer
-  - ``name_tag 'Person', false`` # not Include Person or People in JSON serialization as root, true|false this only implies to root serializer
-  - ``name_tag 'Person'`` # same as ``name_tag 'Person', false``
-  - without name_tag, actual class name of scope object inside serializer will be used 
+#### Options
+
+- `name_tag 'Person', true` # Include Person or People in JSON serialization as root, true|false this only implies to root serializer
+- `name_tag 'Person', false` # not Include Person or People in JSON serialization as root, true|false this only implies to root serializer
+- `name_tag 'Person'` # same as `name_tag 'Person', false`
+- without name_tag, actual class name of scope object inside serializer will be used
+
 ```ruby
 # frozen_string_literal: true
 
@@ -216,7 +252,7 @@ class UserSerializer < Mutils::Serialization::BaseSerializer
   name_tag 'Person', true
   attributes :id, :first_name, :last_name, :email
   custom_methods :full_name
-  
+
   def full_name
     "#{scope.first_name} #{scope.last_name}"
   end
@@ -230,13 +266,17 @@ 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]}

data/bin/reek

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright Codevedas Inc. 2019-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+require 'pty'
+
+root_dir = File.expand_path('..', __dir__)
+Dir.chdir(root_dir)
+
+command = ['bundle', 'exec', 'reek', *ARGV]
+output = +''
+status = nil
+
+PTY.spawn(*command) do |reader, _writer, pid|
+  reader.each { |line| output << line }
+rescue Errno::EIO
+  nil
+ensure
+  _, status = Process.wait2(pid)
+end
+
+print(output.gsub("\r\n", "\n"))
+exit(status.exitstatus || 1)

data/bin/rspec

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Copyright Codevedas Inc. 2019-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
 #
 # This file was generated by Bundler.
 #

data/bin/rubocop

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# Copyright Codevedas Inc. 2019-present
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
 #
 # This file was generated by Bundler.
 #

data/lib/mutils/serialization/methods/attributes.rb

@@ -25,9 +25,7 @@ module Mutils
         end
 
         def attribute(method_name, options = {}, &proc)
-          if options[:if] && !options[:if].instance_of?(Proc)
-            raise "if: should be a Proc object for attribute #{method_name}"
-          end
+          raise "if: should be a Proc object for attribute #{method_name}" if options[:if] && !options[:if].instance_of?(Proc)
 
           if proc.instance_of? Proc
             self.attributes_to_serialize_blocks = {} if attributes_to_serialize_blocks.nil?

data/lib/mutils/serialization/methods/relations.rb

@@ -9,9 +9,7 @@ module Mutils
       # Module Relations
       module Relations
         def relationship(relationship_name, options = {})
-          if options[:if] && !options[:if].instance_of?(Proc)
-            raise "if: should be a Proc object for attribute #{relationship_name}"
-          end
+          raise "if: should be a Proc object for relationship #{relationship_name}" if options[:if] && !options[:if].instance_of?(Proc)
 
           options = prepare_options(relationship_name, options, __callee__)
           self.relationships = {} if relationships.nil?
@@ -23,18 +21,35 @@ module Mutils
         alias has_one relationship
 
         def prepare_options(relationship_name, options, option_name)
-          class_name = options[:serializer]
-          if class_name.nil?
-            raise "Serializer is Required for belongs_to :#{relationship_name}." \
+          serializer, always_include, label = options.values_at(:serializer, :always_include, :label)
+          serializer = fetch_serializer!(relationship_name, serializer, option_name)
+
+          options.merge(
+            serializer: serializer.to_s,
+            always_include: default_always_include(always_include),
+            label: relation_label(label, relationship_name)
+          )
+        end
+
+        private
+
+        def fetch_serializer!(relationship_name, serializer, option_name)
+          if serializer.nil?
+            raise "Serializer is Required for #{option_name} :#{relationship_name}." \
                   "\nDefine it like:\n#{option_name} :#{relationship_name}, " \
                   'serializer: SERIALIZER_CLASS'
           end
-          raise "Serializer class not defined for relationship: #{relationship_name}" unless class_exists? class_name
+          raise "Serializer class not defined for relationship: #{relationship_name}" unless class_exists? serializer
+
+          serializer
+        end
+
+        def default_always_include(always_include)
+          always_include.nil? ? false : always_include
+        end
 
-          options[:serializer] = class_name.to_s
-          options[:always_include] = options[:always_include].nil? ? false : options[:always_include]
-          options[:label] = Lib::Helper.instance.underscore options[:label] || relationship_name
-          options
+        def relation_label(label, relationship_name)
+          Lib::Helper.instance.underscore(label || relationship_name)
         end
       end
     end

data/lib/mutils/version.rb

@@ -2,5 +2,5 @@
 
 # Version
 module Mutils
-  VERSION = '1.3.5'
+  VERSION = '1.3.6'
 end

metadata

@@ -1,11 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: mutils
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Nitesh Purohit
-bindir: exe
+- Codevedas Inc.
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -13,54 +14,31 @@ dependencies:
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: mutils Utilities for rails app
+        version: '1.3'
+description: |
+  Mutils is a general-purpose Ruby helper gem for application development.
+  It currently includes a lightweight serialization toolkit and is designed to grow with additional reusable helpers over time.
 email:
 - nitesh.purohit.it@gmail.com
+- team@codevedas.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".github/FUNDING.yml"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/documentation_issue.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/ISSUE_TEMPLATE/question_or_help.md"
-- ".github/ISSUE_TEMPLATE/report_a_security_vulnerability.md"
-- ".github/ISSUE_TEMPLATE/translations.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/dependabot.yml"
-- ".github/release-drafter.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/codeql.yml"
-- ".github/workflows/release-drafter.yml"
-- ".github/workflows/release.yml"
-- ".gitignore"
-- ".jrubyrc"
-- ".releaserc"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
-- SECURITY.md
-- Version
 - bin/console
+- bin/reek
 - bin/rspec
 - bin/rubocop
 - bin/setup
@@ -81,14 +59,18 @@ files:
 - lib/mutils/serialization/serialization_methods.rb
 - lib/mutils/serialization/serialization_results.rb
 - lib/mutils/version.rb
-- mutils.gemspec
-homepage: https://github.com/code-vedas/mutils
+homepage: https://github.com/Code-Vedas/mutils
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/code-vedas/mutils/issues
+  bug_tracker_uri: https://github.com/Code-Vedas/mutils/issues
+  changelog_uri: https://github.com/Code-Vedas/mutils/blob/main/CHANGELOG.md
+  documentation_uri: https://mutils.codevedas.com
+  homepage_uri: https://github.com/Code-Vedas/mutils
   source_code_uri: https://github.com/Code-Vedas/mutils.git
-  homepage_uri: https://github.com/code-vedas/mutils
+  funding_uri: https://github.com/sponsors/Code-Vedas
+  support_uri: https://mutils.codevedas.com
+  rubygems_uri: https://rubygems.org/gems/mutils
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -104,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.9
 specification_version: 4
-summary: mutils Utilities for rails app
+summary: General-purpose Ruby helpers for application development
 test_files: []

data/.codeclimate.yml

@@ -1,4 +0,0 @@
-plugins:
- rubocop:
-  enabled: true
-  channel: rubocop-0-80

data/.github/FUNDING.yml

@@ -1 +0,0 @@
-github: [Code-Vedas]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,46 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us improve
-title: "[BUG] Briefly describe the issue"
-labels: bug
-assignees: ""
----
-
-## Bug Report
-
-### Description:
-
-[Provide a clear and concise description of the bug.]
-
-### Steps to Reproduce:
-
-1. [First step]
-2. [Second step]
-3. [Third step]
-   - [If applicable]
-
-### Expected Behavior:
-
-[Describe what you expected to happen.]
-
-### Actual Behavior:
-
-[Describe what actually happened.]
-
-### Screenshots or Additional Information:
-
-[If applicable, add screenshots or other information to help illustrate the issue.]
-
-### Environment:
-
-- Operating System: [e.g., Windows, macOS, Linux]
-- Browser (if applicable): [e.g., Chrome, Firefox, Safari]
-- Version: [e.g., 1.0.0]
-
-### Checklist:
-
-- [ ] I have searched for a similar issue and didn't find any duplicates.
-- [ ] I have included all the required information.
-- [ ] I have tagged the issue with the label "bug."
-
-<!-- Feel free to add any additional details or context that might be helpful in resolving the issue. -->

data/.github/ISSUE_TEMPLATE/documentation_issue.md

@@ -1,29 +0,0 @@
----
-name: Documentation Issue
-about: Report an issue with project documentation
-title: "[DOCS] Briefly describe the documentation issue"
-labels: documentation
-assignees: ""
----
-
-## Documentation Issue
-
-### Description:
-
-[Provide a clear and concise description of the documentation issue.]
-
-### Affected Documentation:
-
-[Specify the affected section(s) or page(s) of the documentation.]
-
-### Suggested Improvement:
-
-[If you have a suggestion for improving the documentation, please describe it here.]
-
-### Checklist:
-
-- [ ] I have searched for similar documentation issues and found none.
-- [ ] I have included all the required information.
-- [ ] I have tagged the issue with the label "documentation."
-
-<!-- Feel free to add any additional details that might help in understanding or resolving the documentation issue. -->