as_method 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b333db53f2557a64198bbd51b766bd2aa2335703bef4f294e3afc92b8dbeb51c
-  data.tar.gz: a81108e81da82e920f4b1c5818fdced96800e44bc1e2ecb33110e00b78c51eb3
+  metadata.gz: c681302ea5c6e934c05ec30e0b38cdbfd47d18edd7018eccf845f3f806dc0f10
+  data.tar.gz: 1884622331ca3549ec834b64d314b6b322707e0264357e931eaff341466a55ef
 SHA512:
-  metadata.gz: bfeb95266b9c1a2895d4a6daee298f0538c552035fabadb47b7997aaacd33306be68e92f96794ed9295915583203787693ab4721ebba5e265a597ab2bfe64b75
-  data.tar.gz: fcdff0761a4717339688d8787d8baaa8fbdb1038d5fbefd5f8ac9b21d0621e4cf3ed9f2a80469b6b182e468aa902c04535f44b7ccdce1f01a200fd2a8f96b6b0
+  metadata.gz: 597472c6887db1c5a53d95f09d152b9cdef12734ba04f390707fef324b4e45d373caab26bd7099b89ac50d0328ed6c6455b9e91316055f8c2ec7900f4f6df965
+  data.tar.gz: abee934d4c0da5f4e3fa1f85ed9a74107c76fc1a61e0c597801944e725bde6e5a81fd1405f642fd6ae65db87abe431a41afb8354edb6a4f76d730f07ccd2bd23

data/README.md

@@ -85,3 +85,22 @@ However, be aware of the following points:
 - Dependencies are somewhat implicit as they are defined in a separate file.
 - Object constructors get modified, as explained in detail [here](https://dry-rb.org/gems/dry-auto_inject/0.6/how-does-it-work/)."
 - Resulting methods don't invoke 'call' on objects, they return callables instead.
+
+## Benchmark results:
+
+1000 iterations of a Test Service Object call. It does nothing but calls two other service objects, they call two other service objects each, and so on. (Depth 11 levels, 2049 unique classes, 4095 calls).
+
+```
+                  user       system      total      real       memory
+pure Ruby         3.689327   0.047354   3.736681 ( 3.744128)   27440
+as_method         6.219795   0.038531   6.258326 ( 6.298066)   37652
+dry-auto_inject  22.121456   0.119032  22.240488 (22.467116)   55408
+```
+
+Ruby version: 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin22]
+
+## TODO:
+
+- extra spec for circular dependencies (SO1 includes SO2, SO2 includes SO1, directly and via modules)
+- extra spec for Base Service Object class that includes another SO
+- spec for AsMethod::Allow (extending a base class and a module)

data/lib/as_method/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# rubocop:disable
+module AsMethod
+
+  Configuration = Struct.new(
+    :object_selector,
+    :object_validator,
+    :method_name_generator,
+    :method_name_validator,
+    :module_template
+  )
+
+  DEFAULT_CONFIGURATION = Configuration.new.tap do |config|
+    config.object_selector = ->(object) { object }
+    config.object_validator = ValidateServiceObject
+    config.method_name_generator = MethodName::GenerateFromClassName
+    config.method_name_validator = MethodName::Validate
+    config.module_template = <<~RUBY
+      module <%= module_name %>
+
+        def self.object
+          ::<%= object %>
+        end
+
+        def self.ruby2_keywords(*); end if RUBY_VERSION < "2.7"
+
+        ruby2_keywords def <%= method_name %>(*args, &block)
+          ::<%= object %>.call(*args, &block)
+        end
+
+        <%= method_access %> :<%= method_name %>
+
+      end
+    RUBY
+  end.freeze
+
+end
+# rubocop:enable

data/lib/as_method/generate_module.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module AsMethod
+  class GenerateModule
+    def self.call(**args)
+      new(**args).call
+    end
+
+    def initialize(object:, method_name: nil, method_access: :private)
+      @_object = object
+      @_method_name = method_name
+      @_method_access = method_access
+    end
+
+    def call
+      instance_eval(generate_module_source_code) unless module_exists?
+
+      includable_module
+    end
+
+    private
+
+    def includable_module
+      Object.const_get(module_name)
+    end
+
+    def generate_module_source_code
+      payload = {
+        object: object,
+        module_name: module_name,
+        method_name: method_name,
+        method_access: method_access,
+      }
+      ::ERB.new(config.module_template).result_with_hash(payload)
+    end
+
+    def object
+      @object ||= validate_object!(select_object(@_object))
+    end
+
+    def select_object(object)
+      config.object_selector.call(object)
+    end
+
+    def validate_object!(object)
+      config.object_validator.call(object)
+    end
+
+    def generate_method_name(object_name)
+      config.method_name_generator.call(object_name)
+    end
+
+    def validate_method_name!(method_name)
+      config.method_name_validator.call(method_name)
+    end
+
+    def method_access
+      @method_access ||= @_method_access.to_s.tap do |access|
+        raise ArgumentError unless %w[private public protected].include?(access)
+      end
+    end
+
+    def method_name
+      @method_name ||= validate_method_name!(@_method_name&.to_s || generate_method_name(object.name))
+    end
+
+    def module_name
+      @module_name ||= "::#{object.name}::As#{method_access.capitalize}Method__#{ModuleName::GenerateFromSnakeCase.call(method_name)}" # rubocop:disable Layout/LineLength
+    end
+
+    def module_exists?
+      Object.const_defined?(module_name)
+    end
+
+    def config
+      AsMethod.config
+    end
+  end # ... GenerateModule
+end # ... AsMethod

data/lib/as_method/get_service_object.rb

@@ -54,7 +54,7 @@ module AsMethod
         raise NameError, format(AMBIGUOUS_NAME_ERROR_MSG, @obj.inspect, @method_name.inspect)
       end
 
-      (cmethod || imethod).owner.instance_variable_get(:@_injectable_object)
+      (cmethod || imethod).owner.object
     end
   end # ... GetServiceObject
 end # ... AsMethod

data/lib/as_method/helpers.rb

@@ -14,34 +14,10 @@ module AsMethod
         GetServiceObject.call(self, method_name)
       end
 
-      # rubocop:disable Metrics/AbcSize
       def as_method(object, name: nil, access: :private)
-        raise ArgumentError unless %w[private public protected].include?(access.to_s)
-
-        ValidateServiceObject.call(object)
-
-        # generate method name from object, if none given
-        method_name = name&.to_s || MethodName::GenerateFromClassName.call(object.name)
-
-        MethodName::Validate.call(method_name)
-
-        module_name = "::#{object.name}::As#{access.capitalize}Method__#{ModuleName::GenerateFromSnakeCase.call(method_name)}" # rubocop:disable Layout/LineLength
-
-        # define module, or return existing module:
-        includable_module = FindOrDefineModule.call \
-          module_template: File.read(File.join(__dir__, "templates", "includable_module.rb.erb")),
-          module_name: module_name,
-          vars: {
-            object: object,
-            method_name: method_name,
-            method_access: access,
-          }
-
-        # return generated module ready for inclusion:
+        includable_module = GenerateModule.call(object: object, method_name: name, method_access: access)
         included_modules.include?(includable_module) ? Kernel : includable_module
       end
-      # rubocop:enable Metrics/AbcSize
-
     end # ... ClassMethods
   end # ... Helpers
 end # ... AsMethod

data/lib/as_method/method_name/validate.rb

@@ -9,8 +9,10 @@ module AsMethod
       SPECIAL_NAMES = %w{[] ! ~ + ** - * / % << >> & | ^ < <= >= > == === != =~ !~ <=>}.freeze
 
       def self.call(name)
-        return true if name.to_s =~ REGULAR_NAME_REGEX
-        return true if SPECIAL_NAMES.include?(name.to_s)
+        fail ArgumentError unless name.is_a?(String)
+
+        return name if name =~ REGULAR_NAME_REGEX
+        return name if SPECIAL_NAMES.include?(name)
 
         fail ArgumentError, "invalid method name #{name.inspect}"
       end

data/lib/as_method/validate_service_object.rb

@@ -8,7 +8,7 @@ module AsMethod
         fail TypeError, "#{module_or_class} must be a Class or a Module"
       end
 
-      return if module_or_class.respond_to?(:call)
+      return module_or_class if module_or_class.respond_to?(:call)
 
       fail NoMethodError, "Expected #{module_or_class} to respond to #call method"
     end

data/lib/as_method/version.rb

@@ -2,6 +2,6 @@
 
 module AsMethod
 
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 
 end

data/lib/as_method.rb

@@ -2,9 +2,12 @@
 
 module AsMethod
   autoload :Allow,                          "as_method/allow"
+  autoload :Configuration,                  "as_method/configuration"
+  autoload :DEFAULT_CONFIGURATION,          "as_method/configuration"
   autoload :Helpers,                        "as_method/helpers"
   autoload :FindOrDefineModule,             "as_method/find_or_define_module"
   autoload :ValidateServiceObject,          "as_method/validate_service_object"
+  autoload :GenerateModule,                 "as_method/generate_module"
   autoload :GetServiceObject,               "as_method/get_service_object"
   autoload :VERSION,                        "as_method/version"
 
@@ -18,4 +21,12 @@ module AsMethod
     autoload :GenerateFromClassName,        "as_method/method_name/generate_from_class_name"
   end
 
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config ||= DEFAULT_CONFIGURATION.dup
+  end
+
 end # ... AsMethod

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_method
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Vladimir Gorodulin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies: []
 description: Bring Service Objects to your classes as methods.
 email:
@@ -22,7 +22,8 @@ files:
 - README.md
 - lib/as_method.rb
 - lib/as_method/allow.rb
-- lib/as_method/find_or_define_module.rb
+- lib/as_method/configuration.rb
+- lib/as_method/generate_module.rb
 - lib/as_method/get_service_object.rb
 - lib/as_method/helpers.rb
 - lib/as_method/method_name/generate_from_class_name.rb
@@ -30,7 +31,6 @@ files:
 - lib/as_method/module_name/generate_from_snake_case.rb
 - lib/as_method/module_name/strip_namespace.rb
 - lib/as_method/setup.rb
-- lib/as_method/templates/includable_module.rb.erb
 - lib/as_method/validate_service_object.rb
 - lib/as_method/version.rb
 homepage: https://github.com/gorodulin/as_method

data/lib/as_method/find_or_define_module.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module AsMethod
-  class FindOrDefineModule
-    def self.call(**args)
-      new.call(**args)
-    end
-
-    def call(module_template:, module_name:, vars:)
-      @vars = vars
-      @module_name = module_name
-      @module_template = module_template
-
-      instance_eval(generate_module_source_code) unless module_exists?
-
-      includable_module
-    end
-
-    private
-
-    def generate_module_source_code
-      payload = @vars.merge(module_name: @module_name)
-      ::ERB.new(@module_template).result_with_hash(payload)
-    end
-
-    def includable_module
-      Object.const_get(@module_name)
-    end
-
-    def module_exists?
-      Object.const_defined?(@module_name)
-    end
-  end # ... FindOrDefineModule
-end # ... AsMethod

data/lib/as_method/templates/includable_module.rb.erb

@@ -1,15 +0,0 @@
-
-module <%= module_name %>
-
-  @_injectable_method = "<%= method_name %>"
-  @_injectable_object = <%= object %>
-
-  def self.ruby2_keywords(*); end if RUBY_VERSION < "2.7"
-
-  ruby2_keywords def <%= method_name %>(*args, &block)
-    ::<%= object %>.call(*args, &block)
-  end
-
-  <%= method_access %> :<%= method_name %>
-
-end