mutils 0.2.25

data/lib/generators/serializer/serializer_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class SerializerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :attributes, type: :array, default: [], banner: 'field field'
+
+  def create_serializer_file
+    template 'serializer.rb.tt', File.join('app', 'serializers', class_path, "#{file_name}_serializer.rb")
+  end
+
+  private
+
+    def attributes_names
+      attributes.map { |a| a.name.to_sym.inspect }
+    end
+end

data/lib/generators/serializer/templates/serializer.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# <%= class_name %> Serializer
+<% module_namespacing do -%>
+class <%= class_name %>Serializer < Mutils::Serialization::BaseSerializer
+  attributes <%= attributes_names.join(", ") %>
+end
+<% end -%>

data/lib/mutils.rb

@@ -0,0 +1,11 @@
+require_relative 'mutils/version'
+require 'active_support/concern'
+require_relative 'mutils/serialization/serialization_results'
+require_relative 'mutils/serialization/serialization_includes'
+require_relative 'mutils/serialization/serialization_methods'
+require_relative 'mutils/serialization/base_serializer'
+
+module Mutils
+  class Error < StandardError
+  end
+end

data/lib/mutils/serialization/base_serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'json/ext'
+# module Mutils
+module Mutils
+  module Serialization
+    # BaseSerializer
+    class BaseSerializer
+      include Mutils::Serialization::SerializationIncludes
+      include Mutils::Serialization::SerializationMethods
+      include Mutils::Serialization::SerializationResults
+      attr_accessor :scope, :options, :mutex
+
+      def initialize(object, options = {})
+        self.scope = object
+        self.options = options
+        self.mutex = Mutex.new
+      end
+
+      def as_json(_options = {})
+        to_h
+      end
+
+      def to_h
+        generate_hash
+      end
+
+      def to_json(_options = {})
+        JSON.generate(to_h)
+      end
+    end
+  end
+end

data/lib/mutils/serialization/serialization_includes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module SerializationIncludes
+    module SerializationIncludes
+      extend ActiveSupport::Concern
+      included do
+        class << self
+          attr_accessor :method_to_serialize,
+                        :attributes_to_serialize,
+                        :array_index,
+                        :belongs_to_relationships,
+                        :has_many_relationships
+        end
+      end
+    end
+  end
+end

data/lib/mutils/serialization/serialization_methods.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module SerializationCore
+    module SerializationMethods
+      extend ActiveSupport::Concern
+      module ClassMethods
+        def attributes(*attributes_list)
+          self.attributes_to_serialize = {} if attributes_to_serialize.nil?
+          attributes_list&.each { |attr| attributes_to_serialize[attr] = attr }
+        end
+
+        def custom_methods(*method_list)
+          self.method_to_serialize = {} if method_to_serialize.nil?
+          method_list&.each { |attr| method_to_serialize[attr] = attr }
+        end
+
+        def belongs_to(relationship_name, options = {})
+          if options[:serializer].nil?
+            raise "Serializer is Required for belongs_to :#{relationship_name}." \
+                  "\nDefine it like:\nbelongs_to :#{relationship_name}, " \
+                  'serializer: SERIALIZER_CLASS'
+          end
+          unless class_exists? options[:serializer]
+            raise 'Serializer class not defined'
+          end
+
+          self.belongs_to_relationships = {} if belongs_to_relationships.nil?
+          belongs_to_relationships[relationship_name] = options
+        end
+
+        alias has_one belongs_to
+
+        def has_many(relationship_name, options = {})
+          if options[:serializer].nil?
+            raise "Serializer is Required for has_many :#{relationship_name}." \
+                  "\nDefine it like:\nbelongs_to :#{relationship_name}, " \
+                  'serializer: SERIALIZER_CLASS'
+          end
+          unless class_exists? options[:serializer]
+            raise 'Serializer class not defined'
+          end
+
+          self.has_many_relationships = {} if has_many_relationships.nil?
+          has_many_relationships[relationship_name] = options
+        end
+
+        def class_exists?(class_name)
+          eval("defined?(#{class_name}) && #{class_name}.is_a?(Class)") == true
+        end
+      end
+    end
+  end
+end

data/lib/mutils/serialization/serialization_results.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Module Mutils
+module Mutils
+  module Serialization
+    # Module SerializationResults
+    module SerializationResults
+
+      def generate_hash
+        if scope
+          if scope_is_collection?
+            scope.map { |inner_scope| self.class.new(inner_scope, options).generate_hash }
+          else
+            hashed_result
+          end
+        else
+          {}
+        end
+      end
+
+      def hashed_result
+        relationships = [self.class.belongs_to_relationships, self.class.has_many_relationships]
+        [fetch_attributes(self.class.attributes_to_serialize&.keys),
+         call_methods(self.class.method_to_serialize&.keys),
+         hash_relationships(relationships)].reduce(&:merge)
+      end
+
+      def fetch_attributes(keys)
+        invoke_sends_async(keys)
+      end
+
+      def call_methods(keys)
+        invoke_sends(keys, true)
+      end
+
+      def invoke_sends(keys, call_method = nil)
+        hash = {}
+        keys&.each do |key|
+          invoke_send(hash, key, call_method)
+        end
+        hash
+      end
+
+      def invoke_sends_async(keys, call_method = nil)
+        hash = {}
+        runners = []
+        keys&.each do |key|
+          runners << Thread.new do
+            mutex.synchronize { invoke_send(hash, key, call_method) }
+          end
+        end
+        runners.map(&:join)
+        hash
+      end
+
+      def invoke_send(hash, key, call_method = nil)
+        hash[key] = send(key) if call_method
+        hash[key] = scope.send(key) unless call_method
+        hash
+      end
+
+      def hash_relationships(relationships_array)
+        relationships = relationships_array.compact.reduce(&:merge)
+        hash = {}
+        relationships&.keys&.each do |key|
+          if check_if_included(relationships, key)
+            klass = relationships[key][:serializer]
+            hash[key] = klass.new(scope.send(key)).to_h
+          end
+        end
+        hash
+      end
+
+      def check_if_included(relationships, key)
+        always_include = relationships[key][:always_include]
+        always_include = always_include.nil? ? false : always_include == true
+        always_include || (options[:includes]&.include?(key))
+      end
+
+      def scope_is_collection?
+        scope.respond_to?(:size) && !scope.respond_to?(:each_pair)
+      end
+    end
+  end
+end

data/lib/mutils/version.rb

@@ -0,0 +1,3 @@
+module Mutils
+  VERSION = '0.2.25'.freeze
+end

data/mutils.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mutils/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mutils'
+  spec.version = Mutils::VERSION
+  spec.authors = ['Nitesh Purohit']
+  spec.email = ['nitesh.purohit.it@gmail.com']
+
+  spec.summary = 'mutils Utilities for rails app'
+  spec.description = 'mutils Utilities for rails app'
+  spec.homepage = 'https://github.com/niteshpurohit/mutils'
+  spec.license = 'MIT'
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_rubygems_version = '>= 1.8.11'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency('activesupport', ['>= 4.2'])
+  spec.add_development_dependency 'rspec-rails'
+
+  spec.metadata = {
+      "bug_tracker_uri" => "https://github.com/niteshpurohit/mutils/issues",
+      "source_code_uri" => "https://github.com/niteshpurohit/mutils/tree/v#{Mutils::VERSION}"
+  }
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: mutils
+version: !ruby/object:Gem::Version
+  version: 0.2.25
+platform: ruby
+authors:
+- Nitesh Purohit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: mutils Utilities for rails app
+email:
+- nitesh.purohit.it@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- BENCHMARK-SERIALIZER-JSON.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- benchmark/benchmark-serializer-json.rb
+- bin/console
+- bin/setup
+- lib/generators/serializer/USAGE
+- lib/generators/serializer/serializer_generator.rb
+- lib/generators/serializer/templates/serializer.rb.tt
+- lib/mutils.rb
+- lib/mutils/serialization/base_serializer.rb
+- lib/mutils/serialization/serialization_includes.rb
+- lib/mutils/serialization/serialization_methods.rb
+- lib/mutils/serialization/serialization_results.rb
+- lib/mutils/version.rb
+- mutils.gemspec
+homepage: https://github.com/niteshpurohit/mutils
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/niteshpurohit/mutils/issues
+  source_code_uri: https://github.com/niteshpurohit/mutils/tree/v0.2.25
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: mutils Utilities for rails app
+test_files: []