convenient_service 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53f96dab5d2b97b26168f4859dc0daefe41c8768e83e607d13234c2c7d77101
-  data.tar.gz: c6d5a9d30e5c3c768f556eb7d84b558099fcbeb96dbff655b7bd2b553435a26a
+  metadata.gz: 7bd38d2c3dd6b1e8a5d8baf78b0b017a2e8f46bf17a1099221da1c3f1b6da0cc
+  data.tar.gz: eb5f1bad44ec8d80c6e4b661e354c59c170bb0174dcf9f8c9ee9902f434a3cc4
 SHA512:
-  metadata.gz: 9f3fb867003d44c6786446fdb2baac4550bd6ac8f34ee9196ee310912c4eb2084f40dc731dce8a2af7ac8a963d6a3579c6e886ad28251c4bf5a9a08ca290a6d2
-  data.tar.gz: e24704e463ac31d3f65a4c9a5777617157bdebb62ab785e92f3f18125d8968e5c3a6d44368553c706c9f8bab0ce7bd8f938ce53ebc1df68585493738533ef2cb
+  metadata.gz: fef2d2dda95a3386ebc25494c003053fd72746fac690a4d7b4e1acd4b2eaadf1f858e85ec7340f0a451dc1e658dd288570a1c424671fd47112576870b18935b3
+  data.tar.gz: 055ec4a62139d303a21c058088fb92cea5eae7d520e4f112445a410049564e3c16c23917ac60884b349673e6174a2a16208b58748eb1eb1df6b241a84f327673

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.9.0](https://github.com/marian13/convenient_service/compare/v0.8.0...v0.9.0) (2023-02-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* **export:** add a logic that forbids to use export in classes ([ca81536a](https://github.com/marian13/convenient_service/commit/ca81536a3080661cb762d549f4ef3ce1456bc566))
+
+
+### Features
+
+* **has_result_short_syntax:** introduce Result#ud, Result#um, Result#uc ([95856c9](https://github.com/marian13/convenient_service/commit/95856c921c14888a3253f1c3d12453dbfd97a14b))
+* **utils:** introduce Object#memoize_including_falsy_values ([22b2430](https://github.com/marian13/convenient_service/commit/22b2430f2a57dbded706754261defc53ec140e4f))
+
+
+### Bug Fixes
+
+* **export:** add a logic that forbids to use export in classes ([ca81536a](https://github.com/marian13/convenient_service/commit/ca81536a3080661cb762d549f4ef3ce1456bc566))
+
 ## [0.8.0](https://github.com/marian13/convenient_service/compare/v0.7.0...v0.8.0) (2023-02-20)
 
 

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern.rb

@@ -13,11 +13,43 @@ module ConvenientService
 
                   instance_methods do
                     ##
-                    # NOTE: `Support::Delegate` is NOT used intentionally in order to NOT pollute the public interface.
+                    # @param key [String, Symbol]
+                    # @return [Object] Can be any type.
+                    #
+                    # @internal
+                    #   NOTE: Delegates to `data` instead of aliasing in order to have an ability
+                    #   to use the same RSpec stubs for short and usual syntax.
+                    #
+                    #   For example:
+                    #
+                    #     allow(result).to receive(:data).with(:foo).and_call_original
+                    #
+                    #   works for both `result.data[:foo]` and `result[:foo]`.
                     #
                     def [](key)
                       data[key]
                     end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Data]
+                    #
+                    def ud
+                      unsafe_data
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Message]
+                    #
+                    def um
+                      unsafe_message
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Entities::Code]
+                    #
+                    def uc
+                      unsafe_code
+                    end
                   end
                 end
               end

data/lib/convenient_service/support/dependency_container/errors.rb

@@ -68,6 +68,20 @@ module ConvenientService
             super(message)
           end
         end
+
+        class NotModule < ConvenientService::Error
+          ##
+          # @param klass [Class]
+          # @return [void]
+          #
+          def initialize(klass:)
+            message = <<~TEXT
+              `#{klass.inspect}` is NOT a Module.
+            TEXT
+
+            super(message)
+          end
+        end
       end
     end
   end

data/lib/convenient_service/support/dependency_container/export.rb

@@ -6,6 +6,14 @@ module ConvenientService
       module Export
         include Support::Concern
 
+        ##
+        # @param klass [Class, Module]
+        # @return [Module]
+        #
+        included do |klass|
+          raise Errors::NotModule.new(klass: klass) unless klass.instance_of?(::Module)
+        end
+
         class_methods do
           ##
           # @param full_name [String, Symbol]

data/lib/convenient_service/utils/object/memoize_including_falsy_values.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Utils
+    module Object
+      ##
+      # Can be used instead of `return @ivar if defined? @ivar`.
+      # @see https://www.justinweiss.com/articles/4-simple-memoization-patterns-in-ruby-and-one-gem/
+      #
+      # @note: `false` and `nil` are the only values that are considered `falsy` in Ruby.
+      # @see https://riptutorial.com/ruby/example/2092/truthy-and-falsy-values
+      # @see https://www.ruby-lang.org/en/documentation/faq/6/
+      #
+      # @internal
+      #   NOTE: `falsy` is probably more common than `falsey`.
+      #   - https://developer.mozilla.org/en-US/docs/Glossary/Falsy
+      #
+      class MemoizeIncludingFalsyValues < Support::Command
+        ##
+        # @!attribute [r] object
+        #   @return [Object]
+        #
+        attr_reader :object
+
+        ##
+        # @!attribute [r] ivar_name
+        #   @return [Symbol, String]
+        #
+        attr_reader :ivar_name
+
+        ##
+        # @!attribute [r] value_block
+        #   @return [Proc, nil]
+        #
+        attr_reader :value_block
+
+        ##
+        # @param object [Object]
+        # @param ivar_name [Symbol]
+        # @param value_block [Proc]
+        # @return [void]
+        #
+        def initialize(object, ivar_name, &value_block)
+          @object = object
+          @ivar_name = ivar_name
+          @value_block = value_block
+        end
+
+        ##
+        # @return [Object] Value of ivar. Can be any type.
+        #
+        def call
+          Utils::Object.instance_variable_fetch(object, ivar_name, &value_block)
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/utils/object.rb

@@ -2,6 +2,7 @@
 
 require_relative "object/instance_variable_delete"
 require_relative "object/instance_variable_fetch"
+require_relative "object/memoize_including_falsy_values"
 require_relative "object/resolve_type"
 
 module ConvenientService
@@ -24,6 +25,16 @@ module ConvenientService
           InstanceVariableFetch.call(...)
         end
 
+        ##
+        # @example
+        #   object = Object.new.tap { |object| object.instance_eval { self.class.attr_reader :foo } }
+        #
+        #   ConvenientService::Utils::Object.memoize_including_falsy_values(object, :@foo) { false }
+        #
+        def memoize_including_falsy_values(...)
+          MemoizeIncludingFalsyValues.call(...)
+        end
+
         ##
         # @example
         #   ConvenientService::Utils::Object.resolve_type("foo")

data/lib/convenient_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvenientService
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Marian Kostyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -728,7 +728,6 @@ files:
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_jsend_status_and_attributes/structs/jsend_attributes.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern.rb
-- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern/instance_methods.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/concern.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize.rb
@@ -907,6 +906,7 @@ files:
 - lib/convenient_service/utils/object.rb
 - lib/convenient_service/utils/object/instance_variable_delete.rb
 - lib/convenient_service/utils/object/instance_variable_fetch.rb
+- lib/convenient_service/utils/object/memoize_including_falsy_values.rb
 - lib/convenient_service/utils/object/resolve_type.rb
 - lib/convenient_service/utils/proc.rb
 - lib/convenient_service/utils/proc/conjunct.rb

data/lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern/instance_methods.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResult
-        module Entities
-          class Result
-            module Plugins
-              module HasResultShortSyntax
-                module Concern
-                  module InstanceMethods
-                    ##
-                    # NOTE: `Support::Delegate` is NOT used intentionally in order to NOT pollute the public interface.
-                    #
-                    def [](key)
-                      data[key]
-                    end
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end