plain_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adbcd61a28e79cc60a085bfe6887b7896e6a7e54d2d6e856e82afb83f11a3a85
+  data.tar.gz: 54d5fd5407d810c26a7427200b55a5e82532914cfd0bdde88e1df680d64b01c5
+SHA512:
+  metadata.gz: dfdf44a77c772609e1d2f31555110f3c7e972808503eceb7bf3adfe2a3b985230135abc8008f643b720e09692015eb0dc9db8f638ab9df52b8523377fe765ad1
+  data.tar.gz: 74d18be2fdc7cdd42167a8990ba296f14ba35af43e17e00d24b4eb9cc3bde91da6e345f97cfcdf52a9f4fddf1e98c386053c89bed088661339ddd63bb8914333

data/lib/plain_serializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'plain_serializer/version'
+
+require 'plain_serializer/helpers'
+
+require 'plain_serializer/configurable'
+require 'plain_serializer/modifiable'
+require 'plain_serializer/serializable'
+
+require 'plain_serializer/base'
+
+# The root module
+module PlainSerializer
+end

data/lib/plain_serializer/base.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  # The base class
+  class Base
+    prepend Modifiable
+
+    include Serializable
+    include Configurable
+
+    def initialize(*args)
+      Helpers.extract_options!(args)
+
+      @attributes = args
+    end
+
+    def serialize(entity)
+      return if entity.nil?
+
+      @attributes.each_with_object({}) do |attribute, result|
+        result[attribute] = send(attribute, entity)
+      end
+    end
+
+    def serialize_collection(entities)
+      return if entities.nil?
+
+      entities.each_with_object([]) do |entity, result|
+        result << serialize(entity)
+      end
+    end
+
+    class << self
+      private
+
+      def define_attribute(name)
+        define_method(name) do |entity|
+          entity.send(name)
+        end
+      end
+    end
+  end
+end

data/lib/plain_serializer/configurable.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  # Module which adds support of groups
+  module Configurable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # Defines required methods for base class
+    module ClassMethods
+      def setup(*args)
+        opts = Helpers.extract_options!(args)
+
+        attributes = args.each_with_object([]) do |attribute, result|
+          next result << attribute unless group?(attribute)
+
+          group(attribute).each do |group_attribute|
+            if group_attribute.is_a?(Hash)
+              opts.merge!(group_attribute)
+            else
+              result << group_attribute
+            end
+          end
+        end
+
+        super(*attributes, **opts)
+      end
+
+      private
+
+      def define_group(name, attributes)
+        groups[name] = attributes
+      end
+
+      def groups
+        @groups ||= {}
+      end
+
+      def group(name)
+        groups[name]
+      end
+
+      def group?(name)
+        groups.key?(name)
+      end
+    end
+  end
+end

data/lib/plain_serializer/helpers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  # The module which provides helpers
+  module Helpers
+    module_function
+
+    def extract_options!(array)
+      array.last.is_a?(Hash) ? array.pop : {}
+    end
+  end
+end

data/lib/plain_serializer/modifiable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  # Module which adds support of modifying output
+  module Modifiable
+    def serialize(entity, &block)
+      result = super(entity)
+
+      return if result.nil?
+
+      block&.call(result, entity)
+
+      result
+    end
+
+    def serialize_collection(entities, &block)
+      return if entities.nil?
+
+      entities.each_with_object([]) do |entity, result|
+        result << serialize(entity, &block)
+      end
+    end
+  end
+end

data/lib/plain_serializer/serializable.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  # Module which adds support of nested serializers
+  module Serializable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def setup_serializer(name, attributes)
+      serializers[name] = self.class.serializers[name].setup(*attributes)
+    end
+
+    def serializers
+      @serializers ||= {}
+    end
+
+    def serializer(name)
+      serializers[name] || self.class.serializers[name].new
+    end
+
+    # Defines required methods for base class
+    module ClassMethods
+      def setup(*args)
+        options = Helpers.extract_options!(args)
+
+        attributes = args + options.keys
+
+        new(*attributes).tap do |instance|
+          options.each do |serializer_name, opts|
+            instance.setup_serializer(serializer_name, opts)
+          end
+        end
+      end
+
+      def define_serializer(name, klass)
+        serializers[name] = klass
+
+        define_method(name) do |entity|
+          serializer(name).serialize(entity.send(name))
+        end
+      end
+
+      def define_collection_serializer(name, klass)
+        serializers[name] = klass
+
+        define_method(name) do |entity|
+          serializer(name).serialize_collection(entity.send(name))
+        end
+      end
+
+      def serializers
+        @serializers ||= {}
+      end
+    end
+  end
+end

data/lib/plain_serializer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PlainSerializer
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: plain_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- djezzzl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- lawliet.djez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/plain_serializer.rb
+- lib/plain_serializer/base.rb
+- lib/plain_serializer/configurable.rb
+- lib/plain_serializer/helpers.rb
+- lib/plain_serializer/modifiable.rb
+- lib/plain_serializer/serializable.rb
+- lib/plain_serializer/version.rb
+homepage: https://github.com/djezzzl/plain_serializer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/djezzzl/plain_serializer
+  source_code_uri: https://github.com/djezzzl/plain_serializer
+  changelog_uri: https://github.com/djezzzl/plain_serializer/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plain Serializer DSL
+test_files: []