entity_schema 0.1.2 → 0.1.4

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module EntitySchema
+  module Fields
+    module Specifications
+      # Transform raw valid options to usefull options
+      class Abstract
+        def initialize(name, owner_name, raw_options)
+          @options = transform_options(name: name,
+                                       owner_name: owner_name,
+                                       **raw_options)
+        end
+
+        def [](key)
+          options.fetch(key, nil)
+        end
+
+        def to_h
+          options.dup
+        end
+
+        def method_missing(key, *_args, **_opts)
+          return options[key] if options.key?(key)
+          root = without_predicate(key)
+          return options[root] if bool_key?(root)
+          super
+        end
+
+        def respond_to_missing?(key)
+          options.key?(key) || bool_key?(without_predicate(key))
+        end
+
+        private
+
+        attr_reader :options
+
+        # Hook for ancestors
+        def transform_options(_options)
+          new_strict_hash
+        end
+
+        def bool_key?(key)
+          [true, false].include? options.fetch(key, nil)
+        end
+
+        def without_predicate(key)
+          key.to_s.delete('?').to_sym
+        end
+
+        def new_strict_hash
+          Hash.new do |h, k|
+            raise "Gem works wrong: missed option `#{k.inspect}` called. Options is: #{h.keys}"
+          end
+        end
+
+        def find(*alternatives)
+          alternatives.compact.first
+        end
+
+        # eql(hash, a: 1, b: [1, 2, :value])
+        def eql(input, pairs)
+          pairs.each do |k, values|
+            Array(values).each do |v|
+              return true if input[k] == v
+            end
+          end
+          nil
+        end
+
+        def callable(subject)
+          subject if subject.respond_to?(:call)
+        end
+
+        def owner_meth(option)
+          return unless option.is_a?(Symbol)
+          owner.method(option)
+        end
+
+        def truth(subject)
+          subject == true ? true : nil
+        end
+
+        def to_bool(subject)
+          subject ? true : false
+        end
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/belongs_to.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative 'fk_belongs_to'
+require_relative 'object_belongs_to'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class BelongsTo < Object
+        private
+
+        def transform_options(opts)
+          super.merge!(
+            fk:         opts[:fk] || :"#{opts[:name]}_id",
+            pk:         opts[:pk] || :id
+          )
+        end
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/collection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative 'object'
+require_relative '../collection'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class Collection < Specifications::Object
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/common.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'abstract'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class Common < Abstract
+        private
+
+        def transform_options(input)
+          super.merge!(
+            name:           input[:name],
+            src_key:        input[:key] || input[:name],
+            owner_name:     input[:owner_name],
+            public_getter: !eql(input, getter: :private, private: [:getter, true]),
+            public_setter: !eql(input, setter: :private, private: [:setter, true]),
+            predicate:      false
+          )
+        end
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/fk_belongs_to.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class FkBelongsTo < Common
+        def transform_options(_name, _owner, _options)
+          super.merge!(predicate: false)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative '../object'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class Object < Common
+        private
+
+        def transform_options(o)
+          super.merge!(
+            mapper:     find(callable(o[:mapper]),
+                             owner_meth(o[:mapper]),
+                             mapper(o[:map_to], o[:map_method]),
+                             default_mapper),
+            serializer: find(o[:serializer],
+                             serializer(o))
+          )
+        end
+
+        def mapper(map_to, map_method)
+          return if map_to.nil?
+          map_method ||= :new
+          ->(hash) { map_to.public_send(map_method, hash) }
+        end
+
+        def default_mapper
+          ->(hash) { hash }
+        end
+
+        def serializer(opts)
+          map_method = opts[:serialize] || :to_h
+          ->(object) { object.public_send(map_method) }
+        end
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/object_belongs_to.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+require_relative '../object_belongs_to'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class ObjectBelongsTo < Specifications::Object
+      end
+    end
+  end
+end

data/lib/entity_schema/fields/specifications/property.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'common'
+
+module EntitySchema
+  module Fields
+    module Specifications
+      class Property < Common
+        private
+
+        def transform_options(o)
+          super.merge!(
+            predicate: to_bool(o[:predicate])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/entity_schema/instance_methods.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module EntitySchema
-  # TODO: doc
+  # methods that will be available for interact
+  #   with Entity instances
   module InstanceMethods
     def initialize(params = EMPTY_HASH)
       update_attributes(params)

data/lib/entity_schema/setup_field.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module EntitySchema
+  # Define or redefine methods for work with Entity fields
+  module SetupField
+    def setup_field(field, spec)
+      entity_schema.add_field(field)
+
+      setup_getter(field)
+      setup_setter(field)
+      setup_predicate(field) if spec.predicate?
+    end
+
+    def setup_getter(field)
+      m = field.name
+      define_method(m) { field.get(self) }
+      public(m)  if     field.public_getter?
+      private(m) unless field.public_getter?
+    end
+
+    def setup_setter(field)
+      m = :"#{field.name}="
+      define_method(m) { |value| field.set(self, value) }
+      public(m)  if     field.public_setter?
+      private(m) unless field.public_setter?
+    end
+
+    def setup_predicate(field)
+      m = :"#{field.name}?"
+      remove_method(m) if method_defined?(m)
+      define_method(m) { field.get(self) }
+      public(m)  if     field.public_getter?
+      private(m) unless field.public_getter?
+    end
+  end
+end

data/lib/entity_schema/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entity_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Captain Philipp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,7 +190,6 @@ files:
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -208,24 +207,33 @@ files:
 - lib/entity_schema.rb
 - lib/entity_schema/class_methods.rb
 - lib/entity_schema/dsl.rb
-- lib/entity_schema/dsl_helper.rb
 - lib/entity_schema/fields/abstract.rb
-- lib/entity_schema/fields/builders/.rubocop.yml
-- lib/entity_schema/fields/builders/abstract.rb
 - lib/entity_schema/fields/builders/belongs_to.rb
-- lib/entity_schema/fields/builders/collection.rb
-- lib/entity_schema/fields/builders/fk_belongs_to.rb
-- lib/entity_schema/fields/builders/object.rb
-- lib/entity_schema/fields/builders/object_belongs_to.rb
-- lib/entity_schema/fields/builders/property.rb
 - lib/entity_schema/fields/collection.rb
+- lib/entity_schema/fields/contracts/belongs_to.rb
+- lib/entity_schema/fields/contracts/collection.rb
+- lib/entity_schema/fields/contracts/common.rb
+- lib/entity_schema/fields/contracts/contract.rb
+- lib/entity_schema/fields/contracts/fk_belongs_to.rb
+- lib/entity_schema/fields/contracts/object.rb
+- lib/entity_schema/fields/contracts/object_belongs_to.rb
+- lib/entity_schema/fields/contracts/property.rb
 - lib/entity_schema/fields/fk_belongs_to.rb
 - lib/entity_schema/fields/object.rb
 - lib/entity_schema/fields/object_belongs_to.rb
 - lib/entity_schema/fields/observer_belongs_to.rb
 - lib/entity_schema/fields/property.rb
+- lib/entity_schema/fields/specifications/abstract.rb
+- lib/entity_schema/fields/specifications/belongs_to.rb
+- lib/entity_schema/fields/specifications/collection.rb
+- lib/entity_schema/fields/specifications/common.rb
+- lib/entity_schema/fields/specifications/fk_belongs_to.rb
+- lib/entity_schema/fields/specifications/object.rb
+- lib/entity_schema/fields/specifications/object_belongs_to.rb
+- lib/entity_schema/fields/specifications/property.rb
 - lib/entity_schema/instance_methods.rb
 - lib/entity_schema/schema.rb
+- lib/entity_schema/setup_field.rb
 - lib/entity_schema/version.rb
 homepage: https://github.com/CaptainPhilipp/entity_schema
 licenses:

data/.rubocop_todo.yml

@@ -1,26 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-08-20 00:34:58 +0300 using RuboCop version 0.55.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 14
-Style/Documentation:
-  Exclude:
-    - 'lib/entity_schema.rb'
-    - 'lib/entity_schema/class_methods.rb'
-    - 'lib/entity_schema/dsl_helper.rb'
-    - 'lib/entity_schema/fields/abstract.rb'
-    - 'lib/entity_schema/fields/builders/abstract.rb'
-    - 'lib/entity_schema/fields/builders/belongs_to.rb'
-    - 'lib/entity_schema/fields/builders/collection.rb'
-    - 'lib/entity_schema/fields/builders/fk_belongs_to.rb'
-    - 'lib/entity_schema/fields/builders/object.rb'
-    - 'lib/entity_schema/fields/builders/object_belongs_to.rb'
-    - 'lib/entity_schema/fields/builders/property.rb'
-    - 'lib/entity_schema/fields/collection.rb'
-    - 'lib/entity_schema/fields/object.rb'
-    - 'lib/entity_schema/fields/property.rb'
-    - 'lib/entity_schema/instance_methods.rb'

data/lib/entity_schema/dsl_helper.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module EntitySchema
-  # TODO: remove this shit
-  # TODO: doc
-  module DslHelper
-    def setup_field(field)
-      remove_method(field.name)           if method_defined?(field.name)
-      remove_method(field.predicate_name) if method_defined?(field.predicate_name)
-      remove_method(field.setter_name)    if method_defined?(field.setter_name)
-
-      entity_schema.add_field field
-
-      define_method(field.name) { field.get(self) }
-      private(field.name) unless field.public_getter?
-
-      if field.predicate?
-        define_method(field.predicate_name) { field.get(self) }
-        private(field.predicate_name) unless field.public_getter?
-      end
-
-      define_method(field.setter_name) { |value| field.set(self, value) }
-      private(field.setter_name) unless field.public_setter?
-    end
-  end
-end

data/lib/entity_schema/fields/builders/.rubocop.yml

@@ -1,7 +0,0 @@
-inherit_from: ../../../../.rubocop.yml
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/LineLength:
-  Max: 130

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

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require 'singleton'
-require_relative '../property'
-
-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
-
-        def self.call(*args)
-          instance.call(*args)
-        end
-
-        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, opts)
-        end
-
-        private
-
-        def extract_options(o)
-          {
-            key:     check!(:key, o, [Symbol, nil]),
-            getter:  check!(:getter, o, [:private, nil]),
-            setter:  check!(:setter, o, [:private, nil]),
-            private: check!(:private, o, [true, false, :getter, :setter, nil])
-          }
-        end
-
-        def create_field(name, owner, opts)
-          field_klass.new(name, owner.to_s, **create_field_params(opts, name))
-        end
-
-        # rubocop:disable Metrics/AbcSize:
-        def create_field_params(o, name)
-          {
-            src_key:        first_of(o[:key], name),
-            public_getter: !first_of(true_(o[:getter] == :private), true_(o[:private] == :getter), true_(o[:private]), false),
-            public_setter: !first_of(true_(o[:setter] == :private), true_(o[:private] == :setter), true_(o[:private]), false)
-          }
-        end
-        # rubocop:enable Metrics/AbcSize:
-
-        # :nocov:
-        def field_klass
-          raise NotImplementedError
-        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
-        def check!(key, h, allowed)
-          value = h.delete(key)
-          return value if allowed.any? do |v|
-            v.is_a?(Class) ? value.is_a?(v) : value == v
-          end
-          raise ArgumentError, "option `#{key}:` must be in #{allowed}, but '#{value.inspect}'"
-        end
-        # rubocop:enable Naming/UncommunicativeMethodParamName
-
-        # rubocop:disable Naming/UncommunicativeMethodParamName
-        def check_ducktype!(key, h, methods)
-          value = h.delete(key)
-          return value if value.nil? || methods.all? { |m| value.respond_to?(m) }
-          raise ArgumentError, "option `#{key}:` (#{value.inspect}) must respond to #{methods}"
-        end
-        # rubocop:enable Naming/UncommunicativeMethodParamName
-
-        def first_of(*alternatives)
-          alternatives.compact.first
-        end
-
-        def true_(value)
-          value == true ? true : nil
-        end
-
-        def not_bool(value)
-          case value
-          when true, false then nil
-          else value
-          end
-        end
-
-        def to_bool(value)
-          value ? true : false
-        end
-
-        def guard_unknown_options!(opts, name)
-          raise "Unknown options given to `#{name}:` #{opts.inspect}" if opts.any?
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'abstract'
-require_relative 'object'
-require_relative '../collection'
-
-module EntitySchema
-  module Fields
-    module Builders
-      # TODO: doc
-      class Collection < Builders::Object
-        private
-
-        def field_klass
-          Fields::Collection
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'abstract'
-require_relative '../fk_belongs_to'
-
-module EntitySchema
-  module Fields
-    module Builders
-      # TODO: doc
-      class FkBelongsTo < Abstract
-        def create_field_params(o, name)
-          super.merge!(predicate: false)
-        end
-
-        def field_klass
-          Fields::FkBelongsTo
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'abstract'
-require_relative '../object'
-
-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, 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
-
-        # TODO: test default_mapper, :mapper, :serializer
-        def create_field_params(opts, name)
-          super.merge!(
-            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
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'object'
-require_relative '../object_belongs_to'
-
-module EntitySchema
-  module Fields
-    module Builders
-      # TODO: doc
-      class ObjectBelongsTo < Builders::Object
-        def field_klass
-          Fields::ObjectBelongsTo
-        end
-      end
-    end
-  end
-end