entity_schema 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 175e615c64727f0402ec59b48af5500e84138f10c545f1da46463329d877e538
-  data.tar.gz: 7333bf377c6e6027565d2ff7a1dbf0083f56043db6529e6127df3f7519bd972a
+  metadata.gz: eb6af17a67827a528cf8e5ed2bd486bec9454cfb615e0165fbb324391b9edebb
+  data.tar.gz: a09a8843994a3417b06fc484b78d90266b9354e5853b32ec48cf7bdeda3f3fad
 SHA512:
-  metadata.gz: 20945880185e2307906a80acc9b20ab28e0b3510fcb984c0dd40f7e569166d7d1b8608df5393c645fe046f556f645ff4954ac720b14b183d1da7a31f7065aeb6
-  data.tar.gz: acaefb4a8fbe2d7cfd450e03354938a5022604822a3553e083434ac6041a5a46c8a9d44b018be073758226608a8a3fec3563478f57406598e7f630ffb95c1941
+  metadata.gz: 981e2337ac115f3bf97f734a5f42fdcdbb0cf1bd217f195db591e9fa79009a06fe9d9b73d8c0f59778a5729d324efaf619584a45e0e4ed609ecdd8f4c0942638
+  data.tar.gz: 1b46da351f08c9208fa4c023c5c01a9f619713cc720e2b71c42c80f22a738329798874750cd970a8606a4be518eaccfd83d909ba2f4ad843f72f98dc18344d19

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.1.2]
+### Added
++ added `.object serializer:` and `mapper:` options
++ options `.object serializer:` and `mapper:` can receive `Symbol`, that will be substituted
+  to defined by user _class-level methods_
+
+### Refactored
++ serialization of objects
++ mapping of objects
++ interface of Schema extending from parent schema
++ "unknown field" checking (now, without additional 'if')
+
 ## [0.1.1]
 ### Added (development-only)
 + SimpleCov

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    entity_schema (0.1.1)
+    entity_schema (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/lib/entity_schema/class_methods.rb

@@ -17,7 +17,7 @@ module EntitySchema
                               "`#{Schema}`, but returns a `#{superschema.class}`"
           end
 
-          Schema.new(owner_name: to_s).extends(superschema)
+          Schema.new(owner_name: to_s, extends: superschema)
         else
           Schema.new(owner_name: to_s)
         end

data/lib/entity_schema/dsl.rb

@@ -11,28 +11,28 @@ module EntitySchema
   module Dsl
     include DslHelper
 
-    def property(name, **opts)
-      setup_field Fields::Builders::Property.(name, to_s, opts)
-    end
-
     def property?(name, **opts)
       property(name, opts.merge!(predicate: true))
     end
 
+    def property(name, **opts)
+      setup_field Fields::Builders::Property.(name, self, opts)
+    end
+
     def object(name, **opts)
-      setup_field Fields::Builders::Object.(name, to_s, opts)
+      setup_field Fields::Builders::Object.(name, self, opts)
     end
 
     alias has_one object
 
     def collection(name, **opts)
-      setup_field Fields::Builders::Collection.(name, to_s, opts)
+      setup_field Fields::Builders::Collection.(name, self, opts)
     end
 
     alias has_many collection
 
     def belongs_to(name, **opts)
-      fk, object = Fields::Builders::BelongsTo.(name, to_s, opts)
+      fk, object = Fields::Builders::BelongsTo.(name, self, opts)
       setup_field object
       setup_field fk
     end

data/lib/entity_schema/fields/builders/abstract.rb

@@ -7,6 +7,14 @@ module EntitySchema
   module Fields
     module Builders
       # TODO: doc
+      # Todo: refactor overweight class:
+      #   Responsibilities:
+      #     - options with strict contract and meaningfull exceptions,
+      #     - options transformation,
+      #     - building object,
+      #       building default mappers/serializers
+      #   refactor to Specification, Builder,
+      #         or to ParamsObject, Specification, Builder
       class Abstract
         include Singleton
 
@@ -14,11 +22,11 @@ module EntitySchema
           instance.call(*args)
         end
 
-        def call(name, owner_name, options)
-          options = options.dup
-          opts = extract_options(options)
+        def call(name, owner, options)
+          options = substitute_callable_with_methods(options, owner)
+          opts    = extract_options(options)
           guard_unknown_options!(options, name)
-          create_field(name, owner_name, opts)
+          create_field(name, owner, opts)
         end
 
         private
@@ -32,8 +40,8 @@ module EntitySchema
           }
         end
 
-        def create_field(name, owner_name, opts)
-          field_klass.new(name, owner_name, **create_field_params(opts, name))
+        def create_field(name, owner, opts)
+          field_klass.new(name, owner.to_s, **create_field_params(opts, name))
         end
 
         # rubocop:disable Metrics/AbcSize:
@@ -52,6 +60,14 @@ module EntitySchema
         end
         # :nocov:
 
+        # TODO: test #substitute_callable_with_methods
+        def substitute_callable_with_methods(options, owner)
+          options.dup.tap do |opts|
+            opts[:serializer] = owner.method(opts[:serializer]) if opts[:serializer].is_a?(Symbol)
+            opts[:mapper]     = owner.method(opts[:mapper])     if opts[:mapper].is_a?(Symbol)
+          end
+        end
+
         # Helpers
 
         # rubocop:disable Naming/UncommunicativeMethodParamName

data/lib/entity_schema/fields/builders/object.rb

@@ -7,30 +7,46 @@ module EntitySchema
   module Fields
     module Builders
       # TODO: doc
-
       class Object < Abstract
         private
 
         # rubocop:disable Naming/UncommunicativeMethodParamName
         def extract_options(h)
           super.merge!(
-            mapper:           check_ducktype!(:mapper, h, [:call]),
-            map_to:           check!(:map_to, h, [Class]),
-            map_method:       check!(:map_method, h, [Symbol, nil]),
-            serialize_method: check!(:serialize, h, [Symbol, nil]),
-            serializer:       check_ducktype!(:serializer, h, [:call])
+            mapper:     check_ducktype!(:mapper, h, [:call]),
+            map_to:     check!(:map_to, h, [Class, nil]),
+            map_method: check!(:map_method, h, [Symbol, nil]),
+            serializer: check_ducktype!(:serializer, h, [:call]),
+            serialize:  check!(:serialize, h, [Symbol, nil])
           )
         end
         # rubocop:enable Naming/UncommunicativeMethodParamName
 
-        def create_field_params(o, name)
+        # TODO: test default_mapper, :mapper, :serializer
+        def create_field_params(opts, name)
           super.merge!(
-            map_to:           o[:map_to],
-            map_method:       o[:map_method] || :new,
-            serialize_method: o[:serialize_method] || :to_h
+            mapper:     first_of(opts[:mapper],     build_mapper(opts), default_mapper),
+            serializer: first_of(opts[:serializer], build_serializer(opts))
           )
         end
 
+        def build_mapper(opts)
+          return if opts[:map_to].nil?
+
+          map_to     = opts[:map_to]
+          map_method = opts[:map_method] || :new
+          ->(hash) { map_to.public_send(map_method, hash) }
+        end
+
+        def default_mapper
+          ->(hash) { hash }
+        end
+
+        def build_serializer(opts)
+          map_method = opts[:serialize] || :to_h
+          ->(object) { object.public_send(map_method) }
+        end
+
         def field_klass
           Fields::Object
         end

data/lib/entity_schema/fields/collection.rb

@@ -21,14 +21,12 @@ module EntitySchema
 
       private
 
-      attr_reader :serialize_method
-
-      def map(tuples)
-        tuples.map { |tuple| map_to.public_send(map_method, tuple) }
+      def map(hashes)
+        hashes.map { |hash| super(hash) }
       end
 
       def unwrap(objects)
-        objects.map { |obj| obj.public_send(serialize_method) }
+        objects.map { |object| super(object) }
       end
     end
   end

data/lib/entity_schema/fields/object.rb

@@ -5,9 +5,8 @@ module EntitySchema
     # TODO: doc
     class Object < Abstract
       def initialize(name, schema, options)
-        @map_to           = options.delete(:map_to)
-        @map_method       = options.delete(:map_method)
-        @serialize_method = options.delete(:serialize_method)
+        @mapper     = options.delete(:mapper)
+        @serializer = options.delete(:serializer)
         super(name, schema, options)
         guard_unknown_options!(options)
       end
@@ -21,15 +20,19 @@ module EntitySchema
         return unless given?(obj)
         value = read(obj)
         return output[src_key] = value if value.is_a?(Hash)
-        output[src_key] = value.public_send(serialize_method)
+        output[src_key] = unwrap(value)
       end
 
       private
 
-      attr_reader :map_to, :map_method, :serialize_method
+      attr_reader :mapper, :serializer
 
-      def map(tuple)
-        map_to.public_send(map_method, tuple)
+      def map(hash)
+        mapper.call(hash)
+      end
+
+      def unwrap(object)
+        serializer.call(object)
       end
     end
   end

data/lib/entity_schema/schema.rb

@@ -5,17 +5,16 @@ module EntitySchema
   class Schema
     attr_reader :owner_name
 
-    def initialize(owner_name:)
+    def initialize(owner_name:, extends: nil)
       @owner_name = owner_name
-      @fields = {}
-      @fields_by_key = {}
-    end
 
-    def extends(other)
-      raise 'Cant extend not empty Schema' if fields.any?
-      @fields.merge!        other.fields
-      @fields_by_key.merge! other.fields_by_key
-      self
+      if extends
+        @fields        = extends.fields
+        @fields_by_key = extends.fields_by_key
+      else
+        @fields        = new_strict_hash
+        @fields_by_key = {}
+      end
     end
 
     def add_field(field)
@@ -28,12 +27,10 @@ module EntitySchema
     end
 
     def public_set(obj, name, value)
-      guard_unknown_field!(name)
       fields[name].public_set(obj, value)
     end
 
     def public_get(obj, name)
-      guard_unknown_field!(name)
       fields[name].public_get(obj)
     end
 
@@ -46,12 +43,11 @@ module EntitySchema
     end
 
     def given?(obj, name)
-      guard_unknown_field!(name)
       fields[name].given?(obj)
     end
 
     def weak_given?(obj, name)
-      fields[name]&.given?(obj)
+      fields.fetch(name, nil)&.given?(obj)
     end
 
     # TODO: use it
@@ -69,9 +65,8 @@ module EntitySchema
 
     private
 
-    def guard_unknown_field!(name)
-      return if field?(name)
-      raise NameError, "Unknown field '#{name}' for `#{owner_name}`"
+    def new_strict_hash
+      Hash.new { |_, key| raise NameError, "Unknown field '#{key}' for `#{owner_name}`" }
     end
   end
 end

data/lib/entity_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EntitySchema
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entity_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Captain Philipp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler