mutils 0.2.37 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926c4b4de85c53430599d8d3f0bedc06992bba7475f5bfb63c17c0149b9f5e7c
-  data.tar.gz: 510912f1df040bb65dc4b13d92c7e1e9c3cd976bd29a089dd87449bae7a58813
+  metadata.gz: e38e7ca1f83b872f6a72819355f44ef30a1de7b6c3756abd27e3ec66e256b90a
+  data.tar.gz: a3267a83c8a82770d84f7636f3f8b19aa5039eabcfc6b2953b605981d21e1d6b
 SHA512:
-  metadata.gz: 93232e13da63e6c1dd76a44e0bbce37a0fd0ef030bca6b099c47e8529e4ea4522edcf0b5aaca07c19e9aaba9cf0c9febbfceef651544aadbf5170395c444dd64
-  data.tar.gz: d9fdd7f409e3c7d9dde57ed7a59504aca0145c2dc93f054cd9a6e75b390940f111fb827e352c7510b46864f37175abd266b0f40407b9c4414e6207cdd1baca75
+  metadata.gz: 2a423ea8de2ccf77982fdfec8a9dd9b164a42b0da5b2aa4664889d1e13bae2eba384344bc25c7a24ec8267218a98170c0f7b92c7695926cb72a8b2d6ad695d9b
+  data.tar.gz: 3f1f7b51833b2cb57d8ad2da72aebbca7799ac9f86f61380ab2a9cce5af15bc642591fe5b483d78054a37b4e9ff8b5cbcfe4776537bd8c7da650b83a8ba59679

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/CHANGELOG.md

@@ -1,4 +1,16 @@
 # Changelog
+## [v1.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
 
 ## [v0.2.36](https://github.com/code-vedas/mutils/tree/v0.2.36) (2020-04-14)
 
@@ -108,7 +120,4 @@
 **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))
-
-
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+- Testing Deploy [\#3](https://github.com/code-vedas/mutils/pull/3) ([niteshpurohit](https://github.com/niteshpurohit))

data/Gemfile.lock

@@ -1,12 +1,15 @@
 PATH
   remote: .
   specs:
-    mutils (0.2.36)
+    mutils (1.0.0)
       dry-inflector
 
 GEM
   remote: https://rubygems.org/
   specs:
+    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)
@@ -23,6 +26,11 @@ GEM
       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)
@@ -55,6 +63,7 @@ DEPENDENCIES
   mutils!
   rake (~> 13.0)
   rspec
+  rspec-benchmark
   rspec-json_expectations
 
 BUNDLED WITH

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'

data/lib/mutils/lib/helper.rb

@@ -4,20 +4,30 @@ require 'singleton'
 # module Mutils
 module Mutils
   module Lib
-    # BaseSerializer: inherit this class to get Serializer functionality
+    # Helper: caching expensive repetitive operations
     class Helper
       include Singleton
 
       def initialize
         self.inflector_object = Dry::Inflector.new
+        self.pluralize_cache = {}
+        self.underscore_cache = {}
+        self.constantize_cache = {}
       end
 
       def underscore(string)
-        inflector_object.underscore string
+        underscore_cache[string] = inflector_object.underscore string unless underscore_cache[string]
+        underscore_cache[string]
       end
 
       def pluralize(string)
-        inflector_object.pluralize string
+        pluralize_cache[string] = inflector_object.pluralize string unless pluralize_cache[string]
+        pluralize_cache[string]
+      end
+
+      def constantize(string)
+        constantize_cache[string] = Object.const_get string unless constantize_cache[string]
+        constantize_cache[string]
       end
 
       def collection?(object)
@@ -26,7 +36,7 @@ module Mutils
 
       private
 
-      attr_accessor :inflector_object
+      attr_accessor :inflector_object, :pluralize_cache, :underscore_cache, :constantize_cache
     end
   end
 end

data/lib/mutils/lib/result_hash.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# module Mutils
+module Mutils
+  module Lib
+    # ResultHash: Store result using this class.
+    class ResultHash
+      def initialize
+        self._hash = {}
+      end
+
+      def []=(key, value)
+        _hash[key] = value
+      end
+
+      def hash
+        _hash
+      end
+
+      private
+
+      attr_accessor :_hash
+    end
+  end
+end

data/lib/mutils/serialization/base_serializer.rb

@@ -33,14 +33,6 @@ module Mutils
         JSON.generate(as_json, options)
       end
 
-      def to_xml(_options = {})
-        to_h.to_xml(root: class_name, skip_instruct: true, indent: 2)
-      end
-
-      def as_xml(_options = {})
-        to_xml
-      end
-
       private
 
       attr_writer :scope

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  # Module SerializationCore
+  module Serialization
+    # Module Methods
+    module Methods
+      # Module Attributes
+      module Attributes
+        def attributes(*attributes_list)
+          parse_attributes_methods(attributes_list, false)
+        end
+
+        def custom_methods(*attributes_list)
+          parse_attributes_methods(attributes_list, true)
+        end
+
+        def parse_attributes_methods(list, is_method)
+          self.attributes_to_serialize = {} if attributes_to_serialize.nil?
+          list&.each do |attr|
+            value = { method: is_method, always_include: true }
+            attributes_to_serialize[attr] = value
+          end
+        end
+
+        def attribute(method_name, options = {}, &proc)
+          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?
+            options[:block] = proc
+            attributes_to_serialize_blocks[method_name] = options
+          else
+            add_single_attribute(method_name, options, false)
+          end
+        end
+
+        def custom_method(method_name, options = {})
+          add_single_attribute(method_name, options, true)
+        end
+
+        def add_single_attribute(method_name, options, is_method)
+          self.attributes_to_serialize = {} if attributes_to_serialize.nil?
+          always_include = options[:always_include].nil? ? false : options[:always_include]
+          value = { method: is_method, always_include: always_include, if: options[:if] }
+          attributes_to_serialize[method_name] = value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  # Module SerializationCore
+  module Serialization
+    # Module Methods
+    module Methods
+      # Module Main
+      module Main
+        def name_tag(name_tag, root = nil)
+          self.serializer_name = name_tag
+          self.include_root = root
+        end
+
+        def class_exists?(class_name)
+          klass = begin
+                    Mutils::Lib::Helper.instance.constantize(class_name.to_s)
+                  rescue StandardError
+                    nil
+                  end
+          klass && defined?(klass) && klass.is_a?(Class)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  # Module SerializationCore
+  module Serialization
+    # Module Methods
+    module Methods
+      # Module Relations
+      module Relations
+        def relationship(relationship_name, options = {})
+          raise "if: should be a Proc object for attribute #{relationship_name}" if options[:if] && !options[:if].instance_of?(Proc)
+
+          options = prepare_options(relationship_name, options, __callee__)
+          self.relationships = {} if relationships.nil?
+          relationships[relationship_name] = options
+        end
+
+        alias belongs_to relationship
+        alias has_many relationship
+        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}." \
+                    "\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
+
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module Results
+    module Results
+      # Module Attributes
+      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])
+          end
+        end
+
+        def fetch_attributes(attributes, result_hash)
+          attributes&.each do |key, s_options|
+            check_if_included(s_options, key) && (result_hash[key] = s_options[:method] ? send(key) : scope.send(key))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module Results
+    module Results
+      # Module Attributes
+      module Main
+        def generate_hash
+          if scope
+            if scope_is_collection?
+              options[:child] = true
+              scope.map { |inner_scope| self.class.new(inner_scope, options).generate_hash }
+            else
+              hashed_result(Lib::ResultHash.new)
+            end
+          else
+            {}
+          end
+        end
+
+        def hashed_result(result_hash)
+          fetch_block_attributes(self.class.attributes_to_serialize_blocks, result_hash)
+          fetch_attributes(self.class.attributes_to_serialize, result_hash)
+          hash_relationships(self.class.relationships, result_hash)
+
+          result_hash.hash
+        end
+
+        def check_if_included(s_options, key)
+          return s_options[:if].call(scope) unless s_options[:if].nil? || scope_is_collection?
+
+          s_options[:always_include] || options[:includes]&.include?(key)
+        end
+
+        def scope_is_collection?
+          Lib::Helper.instance.collection? scope
+        end
+
+        def class_name
+          if scope_is_collection?
+            Lib::Helper.instance.pluralize(format_class_name(scope[0]))
+          else
+            format_class_name(scope)
+          end
+        end
+
+        def format_class_name(object)
+          if self.class.serializer_name&.length&.positive?
+            self.class.serializer_name
+          else
+            object.class.to_s.downcase
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module Results
+    module Results
+      # Module Relations
+      module Relations
+        def hash_relationships(relationships_array, result_hash)
+          relationships = relationships_array&.compact
+          relationships&.each do |key, s_options|
+            object = scope.send(key)
+            name = s_options[:label]
+            Lib::Helper.instance.collection?(object) && (name = Lib::Helper.instance.pluralize(name))
+            name = name.to_sym
+            check_if_included(s_options, key) && (result_hash[name] = Lib::Helper.instance.constantize(s_options[:serializer]).new(object).to_h)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mutils/serialization/serialization_methods.rb

@@ -1,90 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'methods/main'
+require_relative 'methods/relations'
+require_relative 'methods/attributes'
 # Module Mutils
 module Mutils
   module Serialization
     # Module SerializationCore
     module SerializationMethods
       def self.included(base)
-        base.extend ClassMethods
-      end
-
-      # Module ClassMethods
-      module ClassMethods
-        def name_tag(name_tag, root = nil)
-          self.serializer_name = name_tag
-          self.include_root = root
-        end
-
-        def attributes(*attributes_list)
-          parse_attributes_methods(attributes_list, 'attributes')
-        end
-
-        def custom_methods(*attributes_list)
-          parse_attributes_methods(attributes_list, 'method')
-        end
-
-        def parse_attributes_methods(list, type)
-          self.attributes_to_serialize = {} if attributes_to_serialize.nil?
-          list&.each do |attr|
-            value = { method: type == 'method', always_include: true }
-            attributes_to_serialize[attr] = value
-          end
-        end
-
-        def attribute(method_name, options = {}, &proc)
-          raise "if: should be a Proc object for attribute #{method_name}" if options[:if] && (options[:if].class.to_s != 'Proc')
-
-          if proc.class.to_s == 'Proc'
-            self.attributes_to_serialize_blocks = {} if attributes_to_serialize_blocks.nil?
-            options[:block] = proc
-            attributes_to_serialize_blocks[method_name] = options
-          else
-            add_single_attribute(method_name, options, 'attribute')
-          end
-        end
-
-        def custom_method(method_name, options = {})
-          add_single_attribute(method_name, options, 'method')
-        end
-
-        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, if: options[:if] }
-          attributes_to_serialize[method_name] = value
-        end
-
-        def relationship(relationship_name, options = {})
-          options = prepare_options(relationship_name, options, __callee__)
-          self.relationships = {} if relationships.nil?
-          relationships[relationship_name] = options
-        end
-
-        alias belongs_to relationship
-        alias has_many relationship
-        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}." \
-                  "\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 "if: should be a Proc object for attribute #{relationship_name}" if options[:if] && (options[:if].class.to_s != 'Proc')
-
-          options[:serializer] = Object.const_get class_name.to_s
-          options[:option_name] = option_name
-          options[:label] = options[:label]
-          options
-        end
-
-        def class_exists?(class_name)
-          klass = Object.const_get class_name.to_s rescue nil
-          klass && defined?(klass) && klass.is_a?(Class)
-        end
+        base.extend Methods::Main
+        base.extend Methods::Attributes
+        base.extend Methods::Relations
       end
     end
   end

data/lib/mutils/serialization/serialization_results.rb

@@ -1,87 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'results/main'
+require_relative 'results/attributes'
+require_relative 'results/relations'
 # Module Mutils
 module Mutils
   module Serialization
     # Module SerializationResults
     module SerializationResults
-      def generate_hash
-        if scope
-          if scope_is_collection?
-            options[:child] = true
-            scope.map { |inner_scope| self.class.new(inner_scope, options).generate_hash }
-          else
-            hashed_result
-          end
-        else
-          {}
-        end
-      end
-
-      def hashed_result
-        [fetch_block_attributes(self.class.attributes_to_serialize_blocks),
-         fetch_attributes(self.class.attributes_to_serialize),
-         hash_relationships(self.class.relationships)].reduce(&:merge)
-      end
-
-      def fetch_block_attributes(attributes)
-        hash = {}
-        attributes&.keys&.each do |key|
-          hash[key] = attributes[key][:block].call(scope, options[:params])
-        end
-        hash
-      end
-
-      def fetch_attributes(attributes)
-        hash = {}
-        attributes&.keys&.each do |key|
-          check_if_included(attributes, key) && (hash[key] = attributes[key][:method] ? send(key) : scope.send(key))
-        end
-        hash
-      end
-
-      def hash_relationships(relationships_array)
-        relationships = relationships_array&.compact
-        hash = {}
-        relationships&.keys&.each do |key|
-          object = scope.send(key)
-          name = key
-          if (label = relationships[key][:label])
-            name = Lib::Helper.instance.underscore label
-            Lib::Helper.instance.collection?(object) && (name = Lib::Helper.instance.pluralize(name))
-            name = name.to_sym
-          end
-          check_if_included(relationships, key) && (hash[name] = relationships[key][:serializer].new(object).to_h)
-        end
-        hash
-      end
-
-      def check_if_included(relationships, key)
-        return relationships[key][:if].call(scope) unless relationships[key][:if].nil? || scope_is_collection?
-
-        always_include = relationships[key][:always_include] == true
-        always_include || options[:includes]&.include?(key)
-      end
-
-      def scope_is_collection?
-        Lib::Helper.instance.collection? scope
-      end
-
-      def class_name
-        if scope_is_collection?
-          Lib::Helper.name.pluralize(format_class_name(scope[0]))
-        else
-          format_class_name(scope)
-        end
-      end
-
-      def format_class_name(object)
-        if self.class.serializer_name&.length&.positive?
-          self.class.serializer_name
-        else
-          object.class.to_s.downcase
-        end
-      end
+      include Mutils::Serialization::Results::Main
+      include Mutils::Serialization::Results::Attributes
+      include Mutils::Serialization::Results::Relations
     end
   end
 end

data/lib/mutils/version.rb

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

data/mutils.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   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 = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutils
 version: !ruby/object:Gem::Version
-  version: 0.2.37
+  version: 1.0.0
 platform: ruby
 authors:
 - Nitesh Purohit
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +133,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -129,7 +142,14 @@ files:
 - lib/generators/mutils/templates/serializer.rb.tt
 - lib/mutils.rb
 - lib/mutils/lib/helper.rb
+- lib/mutils/lib/result_hash.rb
 - lib/mutils/serialization/base_serializer.rb
+- lib/mutils/serialization/methods/attributes.rb
+- lib/mutils/serialization/methods/main.rb
+- lib/mutils/serialization/methods/relations.rb
+- lib/mutils/serialization/results/attributes.rb
+- lib/mutils/serialization/results/main.rb
+- lib/mutils/serialization/results/relations.rb
 - lib/mutils/serialization/serialization_includes.rb
 - lib/mutils/serialization/serialization_methods.rb
 - lib/mutils/serialization/serialization_results.rb
@@ -140,7 +160,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/code-vedas/mutils/issues
-  source_code_uri: https://github.com/code-vedas/mutils/tree/v0.2.37
+  source_code_uri: https://github.com/code-vedas/mutils/tree/v1.0.0
 post_install_message: 
 rdoc_options: []
 require_paths:

data/Makefile

@@ -1,8 +0,0 @@
-changelog:
-	github_changelog_generator --user niteshpurohit --project mutils
-build:
-	bundle exec rake build
-release: build
-	git add .
-	git commit -am '$(MESSAGE)'
-	bundle exec rake release