RubyGems - mutils - Versions diffs - 0.2.34 → 0.2.35 - Mend

mutils 0.2.34 → 0.2.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/.rubocop_todo.yml +4 -0
data/BENCHMARK-SERIALIZER-JSON.md +52 -52
data/CHANGELOG.md +19 -3
data/Gemfile.lock +1 -1
data/README.md +11 -1
data/lib/mutils/serialization/serialization_methods.rb +7 -5
data/lib/mutils/serialization/serialization_results.rb +15 -1
data/lib/mutils/version.rb +1 -1
metadata +3 -3

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2bb3522e87ab43ab73fd33c293f037a362be1711c72e426302ad4895f77965
-  data.tar.gz: 775f6b17dcf6599d9d9e5ed851a18c4d9db769abd80398835430a5e58dcc98e3
+  metadata.gz: 29ea440032b0c3a5961c65970f1e4d9654b19f44d5549c62b178a3401799aae5
+  data.tar.gz: 99d62ab7cc81e88b58644b47ebe607372fb74df7c376adef70f180f9dec6b771
 SHA512:
-  metadata.gz: 6e1103228cb1d0fcf5236812825f240ba1df2bd8f7f8c25a8655906a2a5edab161c5d300b29d44163cdb47570f8272a0bbddcb1ca2e6cee1431d009d9bbf5b3b
-  data.tar.gz: 1c0a90e7dd51811384aa2c8078c888950e6227a301f4283300846b3770fbe204ff5b115d02dfad6ae8b4ac2e134119758d640fd7bea7e32f2003d59f62e718e9
+  metadata.gz: '0278f224aad256658b8b862135e0afcd29ef05873e7b392bc8c8ca5af67e38b1bc31aaf9e500c3349b7674908e3f6821c16ddee8db5b845b867e84718069d35c'
+  data.tar.gz: 18ee155fbc162d27b78056468dc064d755ed2339fd65c0fe677a75cfea73043999ca7244ad28671e076f71e54252b278ab8add538b289b1b82c413934b8a6feb

data/.gitignore CHANGED

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .idea/*
+*.gem

data/.rubocop_todo.yml CHANGED

@@ -35,3 +35,7 @@ Style/RescueModifier:
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 608
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Max: 20

data/BENCHMARK-SERIALIZER-JSON.md CHANGED

@@ -2,81 +2,81 @@
 ruby benchmark/benchmark-serializer-json.rb
 Rehearsal ------------------------------------------------
-fast_jsonapi   0.420896   0.001788   0.422684 (  0.425161)
-=> mutils      0.330089   0.000778   0.330867 (  0.331820)
-as_json        0.328482   0.002571   0.331053 (  0.333599)
-grape_entity   2.136319   0.012292   2.148611 (  2.160330)
-blueprinter    0.809256   0.008755   0.818011 (  0.826980)
-roar           1.905847   0.019966   1.925813 (  1.935937)
-panko          0.323696   0.001208   0.324904 (  0.325517)
---------------------------------------- total: 6.301943sec
+fast_jsonapi   0.469146   0.003692   0.472838 (  0.482972)
+==>mutils      0.343414   0.002338   0.345752 (  0.350116)
+as_json        0.349795   0.002601   0.352396 (  0.355537)
+grape_entity   2.123932   0.008031   2.131963 (  2.142096)
+blueprinter    0.729144   0.005669   0.734813 (  0.737173)
+roar           1.815007   0.015412   1.830419 (  1.831867)
+panko          0.324755   0.000970   0.325725 (  0.325953)
+--------------------------------------- total: 6.193906sec
                    user     system      total        real
-fast_jsonapi   0.329029   0.000763   0.329792 (  0.330612)
-=> mutils      0.255709   0.000688   0.256397 (  0.257546)
-as_json        0.259330   0.001016   0.260346 (  0.261641)
-grape_entity   1.653116   0.004544   1.657660 (  1.659194)
-blueprinter    0.692518   0.003879   0.696397 (  0.700324)
-roar           1.578995   0.011059   1.590054 (  1.598151)
-panko          0.270695   0.000999   0.271694 (  0.272918)
+fast_jsonapi   0.326813   0.000479   0.327292 (  0.328071)
+==>mutils      0.228319   0.000145   0.228464 (  0.228649)
+as_json        0.252139   0.000242   0.252381 (  0.252570)
+grape_entity   1.820288   0.008052   1.828340 (  1.837977)
+blueprinter    0.656481   0.001270   0.657751 (  0.659753)
+roar           1.592949   0.008122   1.601071 (  1.604941)
+panko          0.260401   0.000433   0.260834 (  0.261211)
 Warming up --------------------------------------
         fast_jsonapi     1.000  i/100ms
-           => mutils     1.000  i/100ms
+           ==>mutils     1.000  i/100ms
              as_json     1.000  i/100ms
         grape_entity     1.000  i/100ms
          blueprinter     1.000  i/100ms
                 roar     1.000  i/100ms
                panko     1.000  i/100ms
 Calculating -------------------------------------
-        fast_jsonapi      2.502  (± 2.3%) i/s -     25.000  in  10.025595s
-           => mutils      3.016  (± 3.0%) i/s -     31.000  in  10.322736s
-             as_json      3.766  (± 3.2%) i/s -     38.000  in  10.197421s
-        grape_entity      0.533  (± 4.8%) i/s -      6.000  in  11.273301s
-         blueprinter      1.497  (± 3.8%) i/s -     15.000  in  10.095146s
-                roar      0.631  (± 2.2%) i/s -      7.000  in  11.087625s
-               panko      3.709  (± 3.0%) i/s -     37.000  in  10.073211s
+        fast_jsonapi      2.215  (± 5.1%) i/s -     22.000  in  10.107915s
+           ==>mutils      3.136  (± 3.0%) i/s -     32.000  in  10.281530s
+             as_json      3.455  (± 3.1%) i/s -     35.000  in  10.229037s
+        grape_entity      0.509  (± 7.2%) i/s -      6.000  in  11.844870s
+         blueprinter      1.337  (± 3.9%) i/s -     14.000  in  10.537541s
+                roar      0.613  (± 2.2%) i/s -      7.000  in  11.441661s
+               panko      3.527  (± 2.9%) i/s -     36.000  in  10.292679s
                    with 95.0% confidence
 Comparison:
-             as_json:        3.8 i/s
-               panko:        3.7 i/s - same-ish: difference falls within error
-           => mutils:        3.0 i/s - 1.25x  (± 0.05) slower
-        fast_jsonapi:        2.5 i/s - 1.51x  (± 0.06) slower
-         blueprinter:        1.5 i/s - 2.52x  (± 0.13) slower
-                roar:        0.6 i/s - 5.96x  (± 0.23) slower
-        grape_entity:        0.5 i/s - 7.06x  (± 0.40) slower
+               panko:        3.5 i/s
+             as_json:        3.5 i/s - same-ish: difference falls within error
+           ==>mutils:        3.1 i/s - 1.13x  (± 0.05) slower
+        fast_jsonapi:        2.2 i/s - 1.59x  (± 0.09) slower
+         blueprinter:        1.3 i/s - 2.64x  (± 0.13) slower
+                roar:        0.6 i/s - 5.76x  (± 0.21) slower
+        grape_entity:        0.5 i/s - 6.93x  (± 0.53) slower
                    with 95.0% confidence
 Calculating -------------------------------------
-        fast_jsonapi    62.915M memsize (     0.000  retained)
-                       980.599k objects (     0.000  retained)
+        fast_jsonapi    62.946M memsize (     0.000  retained)
+                       981.039k objects (     0.000  retained)
                         50.000  strings (     0.000  retained)
-           => mutils    76.280M memsize (     0.000  retained)
-                         1.001M objects (     0.000  retained)
-                         6.000  strings (     0.000  retained)
-             as_json    98.069M memsize (     0.000  retained)
-                         1.682M objects (     0.000  retained)
+           ==>mutils    65.112M memsize (     0.000  retained)
+                       721.156k objects (     0.000  retained)
+                         0.000  strings (     0.000  retained)
+             as_json    98.148M memsize (     0.000  retained)
+                         1.683M objects (     0.000  retained)
                          8.000  strings (     0.000  retained)
-        grape_entity   245.598M memsize (     0.000  retained)
-                         2.522M objects (     0.000  retained)
+        grape_entity   245.776M memsize (     0.000  retained)
+                         2.524M objects (     0.000  retained)
                          4.000  strings (     0.000  retained)
-         blueprinter    71.800M memsize (     0.000  retained)
-                       660.626k objects (     0.000  retained)
+         blueprinter    71.856M memsize (     0.000  retained)
+                       661.154k objects (     0.000  retained)
                          0.000  strings (     0.000  retained)
-                roar   220.796M memsize (     0.000  retained)
-                         1.822M objects (     0.000  retained)
+                roar   221.022M memsize (     0.000  retained)
+                         1.823M objects (     0.000  retained)
                          1.000  strings (     0.000  retained)
-               panko    98.073M memsize (     0.000  retained)
-                         1.682M objects (     0.000  retained)
+               panko    98.153M memsize (     0.000  retained)
+                         1.683M objects (     0.000  retained)
                         13.000  strings (     0.000  retained)
 Comparison:
-        fast_jsonapi:   62914944 allocated
-         blueprinter:   71800368 allocated - 1.14x more
-           => mutils:   76279744 allocated - 1.21x more
-             as_json:   98068616 allocated - 1.56x more
-               panko:   98073200 allocated - 1.56x more
-                roar:  220795848 allocated - 3.51x more
-        grape_entity:  245598232 allocated - 3.90x more
+        fast_jsonapi:   62945864 allocated
+           =>>mutils:   65111936 allocated - 1.03x more
+         blueprinter:   71856304 allocated - 1.14x more
+             as_json:   98148488 allocated - 1.56x more
+               panko:   98153072 allocated - 1.56x more
+                roar:  221022344 allocated - 3.51x more
+        grape_entity:  245775576 allocated - 3.90x morre
 ```

data/CHANGELOG.md CHANGED

@@ -1,11 +1,27 @@
 # Changelog
+## [v0.2.34](https://github.com/niteshpurohit/mutils/tree/v0.2.34) (2020-03-29)
+[Full Changelog](https://github.com/niteshpurohit/mutils/compare/v0.2.33...v0.2.34)
+**Merged pull requests:**
+- Feature/attribute can be optional [\#27](https://github.com/niteshpurohit/mutils/pull/27) ([niteshpurohit](https://github.com/niteshpurohit))
+## [v0.2.33](https://github.com/niteshpurohit/mutils/tree/v0.2.33) (2020-03-29)
+[Full Changelog](https://github.com/niteshpurohit/mutils/compare/v0.2.32...v0.2.33)
+**Merged pull requests:**
+- Added new custom\_method in serializer to control if include method [\#26](https://github.com/niteshpurohit/mutils/pull/26) ([niteshpurohit](https://github.com/niteshpurohit))
+- Update CHANGELOG.md [\#25](https://github.com/niteshpurohit/mutils/pull/25) ([niteshpurohit](https://github.com/niteshpurohit))
+- Create .codeclimate.yml [\#24](https://github.com/niteshpurohit/mutils/pull/24) ([niteshpurohit](https://github.com/niteshpurohit))
+- changelog: v0.2.32 [\#22](https://github.com/niteshpurohit/mutils/pull/22) ([niteshpurohit](https://github.com/niteshpurohit))
 ## [v0.2.32](https://github.com/niteshpurohit/mutils/tree/v0.2.32) (2020-03-18)
 [Full Changelog](https://github.com/niteshpurohit/mutils/compare/v0.2.31...v0.2.32)
-**Improvement:**
-- Less Memory Used
-- Greator Performance
 **Merged pull requests:**

data/Gemfile.lock CHANGED

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mutils (0.2.34)
+    mutils (0.2.35)
       activesupport (>= 4.2)
 GEM

data/README.md CHANGED

@@ -64,6 +64,8 @@ Attributes are fields in the model itself. You can reference them by below examp
 # User Serializer
 class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name, :email
+  ## OR
+  attribute :email, {always_include: true} ## this will allow to selectively include email
 end
 ```
 ##### Custom Methods
@@ -76,7 +78,11 @@ Custom methods used in Serializer can be useful for cases as below.
 # User Serializer
 class UserSerializer < Mutils::Serialization::BaseSerializer
   attributes :id, :first_name, :last_name, :email
+  ###
   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}"
@@ -88,14 +94,18 @@ 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

data/lib/mutils/serialization/serialization_methods.rb CHANGED

@@ -29,16 +29,17 @@ module Mutils
           end
         end
-        def attribute(method_name, always_include = false)
-          add_single_attribute(method_name, always_include, 'attribute')
+        def attribute(method_name, options = {})
+          add_single_attribute(method_name, options, 'attribute')
         end
-        def custom_method(method_name, always_include = false)
-          add_single_attribute(method_name, always_include, 'method')
+        def custom_method(method_name, options = {})
+          add_single_attribute(method_name, options, 'method')
         end
-        def add_single_attribute(method_name, always_include, type)
+        def add_single_attribute(method_name, options, type)
           self.attributes_to_serialize = {} if attributes_to_serialize.nil?
+          always_include = options[:always_include].nil? ? false : options[:always_include]
           value = { method: type == 'method', always_include: always_include }
           attributes_to_serialize[method_name] = value
         end
@@ -64,6 +65,7 @@ module Mutils
           options[:serializer] = class_name.to_s.constantize
           options[:option_name] = option_name
+          options[:label] = options[:label]
           options
         end

data/lib/mutils/serialization/serialization_results.rb CHANGED

@@ -34,7 +34,17 @@ module Mutils
       def hash_relationships(relationships_array)
         relationships = relationships_array&.compact
         hash = {}
-        relationships&.keys&.each { |key| check_if_included(relationships, key) && (hash[key] = relationships[key][:serializer].new(scope.send(key)).to_h) }
+        relationships&.keys&.each do |key|
+          object = scope.send(key)
+          label = relationships[key][:label]
+          name = key
+          if label
+            name = label.underscore
+            name = name.pluralize if collection? object
+            name = name.to_sym
+          end
+          check_if_included(relationships, key) && (hash[name] = relationships[key][:serializer].new(object).to_h)
+        end
         hash
       end
@@ -47,6 +57,10 @@ module Mutils
         scope.respond_to?(:size) && !scope.respond_to?(:each_pair)
       end
+      def collection?(object)
+        object.respond_to?(:size) && !object.respond_to?(:each_pair)
+      end
       def class_name
         if scope_is_collection?
           format_class_name(scope[0]).pluralize

data/lib/mutils/version.rb CHANGED

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Mutils
-  VERSION = '0.2.34'
+  VERSION = '0.2.35'
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutils
 version: !ruby/object:Gem::Version
-  version: 0.2.34
+  version: 0.2.35
 platform: ruby
 authors:
 - Nitesh Purohit
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,7 +156,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/niteshpurohit/mutils/issues
-  source_code_uri: https://github.com/niteshpurohit/mutils/tree/v0.2.34
+  source_code_uri: https://github.com/niteshpurohit/mutils/tree/v0.2.35
 post_install_message:
 rdoc_options: []
 require_paths: