luna_park 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc89904bfac7a26a4898141e26a1ec059fdc19a5de2adc7dca5c54e58e04bee8
-  data.tar.gz: 142b00eeb4fee4f412b9a811e196104b4522a1354a95b5e58dbc766b7e3e8a3c
+  metadata.gz: bdf7e8b655b452fed676d668734e7ff9aa9ce6acab8fba29db0e07bd22b9b24d
+  data.tar.gz: 55adce683441034c0b47f1b1f93e45c7d562e7d965ce800eb73e72e71304d73c
 SHA512:
-  metadata.gz: 8443e5c9f90f0a80647eebe61453e21a0de3130bd16147171dd19ed4df25217b8f8b85d09754b3105b82e3a51485f9fbb6c5726838705f3ba03363fb28fd01fb
-  data.tar.gz: a6c102273edc954cd156d9f68cc250a22c0ef272d89650a1a84779724e43b507ed8fa40b5704096152efdcc0b6abf2bf29a837de028ac5b9919c3d7905d75eb8
+  metadata.gz: 49af03152d02807005c2b308f67d4ce5553762a15608e5a562c5c024ede6ccdc0526c9890e55ab4095302bb80e29b86ae5066b39d43892121ec65b6339c1f744
+  data.tar.gz: 03ab2f5cc9c4c4b945ad0f50a39e841a08b5ab1ecb137b7cbba1ee099270765e21fb63b391ec867bba6eaee5d82d207479b39e04bdc15a36fd62c74860f2cb80

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.11.3] - 2021-09-02
+Added 
+- new mapper `Mappers::Codirectionsl` with DSL
+
 ## [0.11.2] - 2021-09-01
 Added 
 - Github CI

data/Gemfile.lock

@@ -6,7 +6,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     bugsnag (6.13.1)
@@ -95,7 +95,7 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.1)

data/lib/luna_park/extensions/exceptions/substitutive.rb

@@ -4,7 +4,6 @@ module LunaPark
   module Extensions
     module Exceptions
       # class-level mixin
-
       module Substitutive
         def self.extended(base)
           base.extend  ClassMethods

data/lib/luna_park/extensions/injector/dependencies.rb

@@ -48,7 +48,7 @@ module LunaPark
         #    use_case.dependencies[:messenger] # => #<Proc:0x0000564a0d90d438@t.rb:34>
         #    use_case.dependencies.call_with_cache(:messenger) # => 'Foobar'
         def call_with_cache(key)
-          cache.key?(key) ? cache[key] : cache[key] = self.fetch(key).call
+          cache.key?(key) ? cache[key] : cache[key] = fetch(key).call
         end
 
         def []=(key, _val)

data/lib/luna_park/extensions/injector.rb

@@ -126,7 +126,7 @@ module LunaPark
         def dependency(name, &block)
           raise ArgumentError, 'no block given' unless block_given?
 
-          self.dependencies[name] = block
+          dependencies[name] = block
 
           define_method(name) do
             dependencies.call_with_cache(name)

data/lib/luna_park/mappers/codirectional/copyists/nested.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module LunaPark
+  module Mappers
+    class Codirectional < Simple
+      module Copyists
+        # Copyist for copiyng value between two schemas with DIFFERENT or NESTED paths
+        #   (Works with only one described attribute)
+        class Nested
+          def initialize(attrs_path:, row_path:)
+            @attrs_path = attrs_path
+            @row_path   = row_path
+
+            raise ArgumentError, 'attr path can not be nil'  if attrs_path.nil?
+            raise ArgumentError, 'store path can not be nil' if row_path.nil?
+          end
+
+          def from_row(row:, attrs:)
+            copy_nested(from: row, to: attrs, from_path: @row_path, to_path: @attrs_path)
+          end
+
+          def to_row(row:, attrs:)
+            copy_nested(from: attrs, to: row, from_path: @attrs_path, to_path: @row_path)
+          end
+
+          private
+
+          def copy_nested(from:, to:, from_path:, to_path:)
+            value = read(from, from_path)
+
+            return if value == Undefined # omit undefined keys
+
+            write(to, to_path, value)
+          end
+
+          def read(from, from_path)
+            if from_path.is_a?(Array) # when given `%i[key path]` - not just `:key`
+              read_nested(from, path: from_path)
+            else # when given just `:key`
+              read_plain(from, key: from_path)
+            end
+          end
+
+          def write(to, to_path, value)
+            if to_path.is_a?(Array) # when given `%i[key path]` - not just `:key`
+              write_nested(to, to_path, value)
+            else # when given just `:key`
+              to[to_path] = value
+            end
+          end
+
+          def read_nested(from, path:)
+            *path_to_head, head_key = path      # split `[:a, :b, :c]` to `[:a, :b]` and `:c`
+            head_hash = from.dig(*path_to_head) # from `{a: {b: {c: 'value'}}}` get `{c: 'value'}`
+
+            return Undefined if     head_hash.nil?           # when there are no key at the path `[:a, :b]`
+            return Undefined unless head_hash.key?(head_key) # when there are no key at the path `[:a, :b, :c]`
+
+            head_hash[head_key] # get 'value' from from `{c: 'value'}` stored at `{a: {b: {c: 'value'}}}`
+          end
+
+          def read_plain(from, key:)
+            from.key?(key) ? from[key] : Undefined
+          end
+
+          def write_nested(hash, full_path, value)
+            *tail_path, head_key = full_path
+            build_nested_hash(hash, tail_path)[head_key] = value
+          end
+
+          #
+          # @example
+          #   hash = { a: { x: 'x' } }
+          #   build_nested_hash(hash, [:a, :b, :c]) # => {} # (returns new hash at path [:a, :b, :c])
+          #   hash # => { a: { b: { c: {} }, x: 'x' } }
+          #
+          # @example
+          #   hash = { a: { x: 'x' } }
+          #   build_nested_hash(hash, [:a, :b, :c])[:d] = 'value'
+          #   hash # => { a: { b: { c: { d: 'value' } }, x: 'x' } }
+          def build_nested_hash(nested_hash, path)
+            path.inject(nested_hash) { |output, key| output[key] ||= {} }
+          end
+
+          class Undefined; end
+
+          private_constant :Undefined
+        end
+      end
+    end
+  end
+end

data/lib/luna_park/mappers/codirectional/copyists/slice.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LunaPark
+  module Mappers
+    class Codirectional < Simple
+      module Copyists
+        # Copyist for copiyng value between two schemas with SAME and PLAIN paths
+        class Slice
+          def initialize
+            @keys = []
+          end
+
+          def add_key(key)
+            @keys << key
+          end
+
+          def from_row(row:, attrs:)
+            attrs.merge! row.slice(*@keys)
+          end
+
+          def to_row(row:, attrs:)
+            row.merge! attrs.slice(*@keys)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luna_park/mappers/codirectional.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'luna_park/mappers/simple'
+require 'luna_park/mappers/codirectional/copyists/slice'
+require 'luna_park/mappers/codirectional/copyists/nested'
+
+module LunaPark
+  module Mappers
+    ##
+    # DSL for describe Nested Schema translation: entity attributes to database row and vice-versa
+    #
+    # @example
+    #   class Mappers::Transaction < LunaPark::Mappers::Codirectional
+    #     map attr: :uid,                 row: :id
+    #     map attr: [:charge, :amount],   row: :charge_amount
+    #     map attr: [:charge, :currency], row: :charge_currency # using aliased args
+    #     map :comment
+    #   end
+    # 
+    #   mapper = Mappers::Transaction
+    #
+    #   attrs = { charge: { amount: 10, currency: 'USD' }, comment: 'Foobar' }
+    #   transaction = Entities::Transaction.new(attrs)
+    #
+    #   # Mapper transforms attr attributes to database row and vice-verse
+    #   row       = mapper.to_row(transaction)        # => {          charge_amount: 10, charge_currency: 'USD', comment: 'Foobar' }
+    #   new_row   = sequel_database_table.insert(row) # => { id:  42, charge_amount: 10, charge_currency: 'USD', comment: 'Foobar' }
+    #   new_attrs = mapper.from_row(new_row)          # => { uid: 42, charge: { amount: 10, currency: 'USD' },   comment: 'Foobar' }
+    #
+    #   transaction.set_attributes(new_attrs)
+    #   transaction.to_h # => { uid: 42, charge: { amount: 10, currency: 'USD' }, comment: 'Foobar' }
+    class Codirectional < Simple
+      class << self
+        ##
+        # Describe translation between two schemas: attr and table
+        #
+        # @example
+        #   class Mappers::Transaction < LunaPark::Mappers::Codirectional
+        #     map attr: :id,                row: :uid
+        #     map attr: [:charge, :amount], row: :charge_amount
+        #     map :comment
+        #   end
+        #
+        #   Mappers::Transaction.from_row({ id: 1, charge_amount: 2 })     # => { uid: 1, charge: { amount: 2 } }
+        #   Mappers::Transaction.to_row({ uid: 1, charge: { amount: 2 } }) # => { id: 1, charge_amount: 2 }
+        def map(*common_keys, attr: nil, row: nil)
+          attrs(*common_keys) if common_keys.any?
+
+          self.attr attr, row: row if attr
+        end
+
+        # @example
+        #   class Mappers::Transaction < LunaPark::Mappers::Codirectional
+        #     attr :uid,              row: :id
+        #     attr %i[charge amount], row: :charge_amount
+        #   end
+        def attr(attr, row: nil)
+          return attrs(attr) if row.nil?
+
+          attr_path = to_path(attr)
+          row_path  = to_path(row)
+
+          if attr_path == row_path
+            attrs(attr_path)
+          else
+            nested_copyists << Copyists::Nested.new(attrs_path: attr_path, row_path: row_path)
+          end
+        end
+
+        # @example
+        #   class Mappers::Transaction < LunaPark::Mappers::Codirectional
+        #     attrs :comment, :uid, %i[addresses home], :created_at
+        #   end
+        def attrs(*common_keys)
+          common_keys.each do |common_key|
+            path = to_path(common_key)
+            if path.is_a?(Array)
+              nested_copyists << Copyists::Nested.new(attrs_path: path, row_path: path)
+            else
+              slice_copyist.add_key(path)
+            end
+          end
+        end
+
+        def from_row(input)
+          row = input.to_h
+          {}.tap do |attrs|
+            slice_copyist.from_row(row: row, attrs: attrs)
+            nested_copyists.each { |copyist| copyist.from_row(row: row, attrs: attrs) }
+          end
+        end
+
+        def to_row(input)
+          attrs = input.to_h
+          {}.tap do |row|
+            slice_copyist.to_row(row: row, attrs: attrs)
+            nested_copyists.each { |copyist| copyist.to_row(row: row, attrs: attrs) }
+          end
+        end
+
+        private
+
+        # @example
+        #   to_path :email              # => :email
+        #   to_path ['email']           # => :email
+        #   to_path [:charge, 'amount'] # => [:charge, :amount]
+        def to_path(input, full: input)
+          case input
+          when Symbol then input
+          when String then input.to_sym
+          when Array
+            return to_path(input.first, full: full) if input.size <= 1
+
+            input.flat_map { |elem| to_path(elem, full: full) }
+          else raise ArgumentError, "Unexpected path part `#{input.inspect}` in `#{full.inspect}`. " \
+                                    'Expected Symbol, String or Array'
+          end
+        end
+
+        def slice_copyist
+          @slice_copyist ||= Copyists::Slice.new
+        end
+
+        def nested_copyists
+          @nested_copyists ||= []
+        end
+      end
+    end
+  end
+end

data/lib/luna_park/mappers/errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'luna_park/errors'
+
+module LunaPark
+  module Mappers
+    module Errors
+      class NotArray < LunaPark::Errors::System
+        message { |d| "input MUST be an Array, but given #{d[:input].class} `#{d[:input].inspect}`" }
+      end
+    end
+  end
+end

data/lib/luna_park/mappers/simple.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-require 'luna_park/errors'
+require 'luna_park/mappers/errors'
 
 module LunaPark
   module Mappers
+    ##
     # Abstract mapper for transform data from Entity attributes schema to Database row schema
+    #
     # @example
     #   class TransactionMapper < LunaPark::Mappers::Simple
     #     def self.from_row(row)
@@ -65,6 +67,7 @@ module LunaPark
         # Transforms array of rows to array of attribute hashes
         def from_rows(rows)
           return [] if rows.nil?
+          raise Errors::NotArray.new(input: rows) unless rows.is_a?(Array)
 
           rows.to_a.map { |hash| from_row(hash) }
         end
@@ -73,18 +76,19 @@ module LunaPark
         # Transforms array of attribute hashes to array of rows
         def to_rows(attr_hashes)
           return [] if attr_hashes.nil?
+          raise Errors::NotArray.new(input: attr_hashes) unless attr_hashes.is_a?(Array)
 
           attr_hashes.to_a.map { |entity| to_row(entity) }
         end
 
         # @abstract
         def from_row(_row)
-          raise Errors::AbstractMethod
+          raise LunaPark::Errors::AbstractMethod
         end
 
         # @abstract
         def to_row(_attrs)
-          raise Errors::AbstractMethod
+          raise LunaPark::Errors::AbstractMethod
         end
       end
     end

data/lib/luna_park/use_cases/scenario.rb

@@ -252,6 +252,7 @@ module LunaPark
       end
 
       alias failure? fail?
+      alias failed? fail?
 
       # @return [Boolean] true if the scenario runs successfully
       def success?
@@ -318,7 +319,7 @@ module LunaPark
       end
 
       def on_raise(error)
-        raise error.cover_up_backtrace
+        raise error
       end
     end
   end

data/lib/luna_park/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LunaPark
-  VERSION = '0.11.2'
+  VERSION = '0.11.3'
 end

data/lib/luna_park.rb

@@ -67,6 +67,7 @@ require 'luna_park/values/compound'
 require 'luna_park/values/single'
 require 'luna_park/values/attributable'
 require 'luna_park/mappers/simple'
+require 'luna_park/mappers/codirectional'
 require 'luna_park/repository'
 require 'luna_park/repositories/sequel'
 require 'luna_park/repositories/postgres'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luna_park
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Alexander Kudrin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bugsnag
@@ -368,6 +368,10 @@ files:
 - lib/luna_park/http/request.rb
 - lib/luna_park/http/response.rb
 - lib/luna_park/http/send.rb
+- lib/luna_park/mappers/codirectional.rb
+- lib/luna_park/mappers/codirectional/copyists/nested.rb
+- lib/luna_park/mappers/codirectional/copyists/slice.rb
+- lib/luna_park/mappers/errors.rb
 - lib/luna_park/mappers/simple.rb
 - lib/luna_park/notifiers/bugsnag.rb
 - lib/luna_park/notifiers/log.rb