defi 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd965274ab9b7a6dd1303d7aa7b4c1da9c87551c6197a5075ea1f6a8c409df52
-  data.tar.gz: 2fc6a867f949feeb94e971347313fd1b734c5851bb1f770e77bc6b2c0d72e9d8
+  metadata.gz: cbd2a5befa5ac9808bfe1c121549311dfed58c0a48070b9708ec46621a101255
+  data.tar.gz: b1f16e2e70d07e377e7f662a807afb1afbe9cc971535cb683d5000b19b0306de
 SHA512:
-  metadata.gz: 99d0012c6768b9e38db3a149cb9021c3fdad056705748079e8e33ca6b7e05f55ec551ea1b784eb2cfba31dd3bae2f5454d75eeb8469fa5372321c192c42dcf99
-  data.tar.gz: 789d8cd29d0cb8d608980c88b995d5d188e93febf868715113a1b274fe35cb54f2cd01f5b7a0f57d3e5ba804099c3129ab824e7ecfc0b50cf6b903df926bd935
+  metadata.gz: a673ab6344aa7f6ebe0b04ff7556b0f3d5524cec97f26810613858afe874f96362081a293cabadcdcf8a09da1c10c75ef8fa0e5a3efc39fc3f075660febc6a9a
+  data.tar.gz: a8c78c9725743ba1efeb8e3ac12afb5dca6403d8a7d6b714142814db42d7d60b075b5a3d5431a2145b33319f2c6d08742e50fe91d4e7ea5916579a8185b4bcdd

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2024 Cyril Kato
+Copyright (c) 2015-2025 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,8 +2,6 @@
 
 [![Version](https://img.shields.io/github/v/tag/fixrb/defi?label=Version&logo=github)](https://github.com/fixrb/defi/tags)
 [![Yard documentation](https://img.shields.io/badge/Yard-documentation-blue.svg?logo=github)](https://rubydoc.info/github/fixrb/defi/main)
-[![Ruby](https://github.com/fixrb/defi/workflows/Ruby/badge.svg?branch=main)](https://github.com/fixrb/defi/actions?query=workflow%3Aruby+branch%3Amain)
-[![RuboCop](https://github.com/fixrb/defi/workflows/RuboCop/badge.svg?branch=main)](https://github.com/fixrb/defi/actions?query=workflow%3Arubocop+branch%3Amain)
 [![License](https://img.shields.io/github/license/fixrb/defi?label=License&logo=github)](https://github.com/fixrb/defi/raw/main/LICENSE.md)
 
 **Defi** is a streamlined Ruby library designed for the specification of method arguments while respecting their signatures.
@@ -83,11 +81,6 @@ __Defi__ follows [Semantic Versioning 2.0](https://semver.org/).
 
 The [gem](https://rubygems.org/gems/defi) is available as open source under the terms of the [MIT License](https://github.com/fixrb/defi/raw/main/LICENSE.md).
 
----
+## Sponsors
 
-<p>
-  This project is sponsored by:<br />
-  <a href="https://sashite.com/"><img
-    src="https://github.com/fixrb/defi/raw/main/img/sashite.png"
-    alt="Sashité" /></a>
-</p>
+This project is sponsored by [Sashité](https://sashite.com/)

data/lib/defi/method.rb

@@ -2,18 +2,19 @@
 
 module Defi
   # Represents a method to be applied against an object.
-  # This class encapsulates the method name, its arguments, keyword arguments,
-  # and an optional block, enabling dynamic method invocation.
+  # Encapsulates method name, arguments, keyword arguments and blocks
+  # for dynamic method invocation with proper error handling.
   class Method < ::BasicObject
     # Initialize a new Method object.
     #
-    # @param name  [Symbol] The name of the method.
-    # @param args  [Array]  Any arguments of the method.
-    # @param opts  [Hash]   Any keyword arguments of the method.
-    # @param block [Proc]   Any block argument of the method.
-    # @raise [ArgumentError] If the name is not a symbol.
+    # @param name [Symbol] The method name
+    # @param args [Array] Positional arguments
+    # @param opts [Hash] Keyword arguments
+    # @param block [Proc] Optional block
+    #
+    # @raise [ArgumentError] If name is not a Symbol, raises with the actual class received
     def initialize(name, *args, **opts, &block)
-      raise ::ArgumentError, name.class.inspect unless name.is_a?(::Symbol)
+      raise ::ArgumentError, "Method name must be a Symbol, got: #{name.class}" unless name.is_a?(::Symbol)
 
       @name = name
       @args = args
@@ -23,19 +24,23 @@ module Defi
 
     # Applies the method to the given object.
     #
-    # @example
-    #   add = Defi::Method.new(:+, 1)
-    #   add.to(2).call # => 3
+    # @param object [#object_id] Target object for method invocation
+    # @return [Defi::Value] Result wrapper containing return value or exception
+    #
+    # @example Basic arithmetic
+    #   Defi::Method.new(:+, 1).to(2).call # => 3
     #
-    # @param object [#object_id] The object to method.
-    # @return [Defi::Value] The actual value, to raise or to return.
+    # @example Block usage
+    #   Defi::Method.new(:map) { |x| x * 2 }.to([1, 2, 3]).call # => [2, 4, 6]
+    #
+    # @example Error handling
+    #   result = Defi::Method.new(:undefined).to(42)
+    #   result.raised? # => true
     def to(object)
       Value.new { object.public_send(@name, *@args, **@opts, &@block) }
     end
 
-    # Returns a hash containing the method's properties.
-    #
-    # @return [Hash] The properties of the method.
+    # @return [Hash] Method properties
     def to_h
       {
         name:  @name,
@@ -45,53 +50,54 @@ module Defi
       }
     end
 
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-
-    # Returns a string representation of the method.
+    # @return [String] Human-readable representation
     #
     # @example
-    #   add = Defi::Method.new(:+, 1)
-    #   add.to_s # => ".+(1)"
+    #   Defi::Method.new(:+, 1).inspect
+    #   # => "Defi(name: :+, args: [1], opts: {}, block: nil)"
+    def inspect
+      "Defi(" \
+        "name: #{@name.inspect}, " \
+        "args: #{@args.inspect}, " \
+        "opts: #{@opts.inspect}, " \
+        "block: #{@block.nil? ? "nil" : "<Proc>"})"
+    end
+
+    # @return [String] String representation of the method call
     #
-    # @return [String] The string representation of the method.
+    # @example
+    #   Defi::Method.new(:+, 1).to_s # => ".+(1)"
+    #   Defi::Method.new(:map) { |x| x }.to_s # => ".map(<Proc>)"
     def to_s
-      string = ".#{@name}"
-      return string if @args.empty? && @opts.empty? && @block.nil?
+      return ".#{@name}" if no_arguments?
 
-      stringified_args  = @args.inspect[1..-2]
-      stringified_opts  = @opts.inspect[1..-2]
-      stringified_block = "<Proc>" unless @block.nil?
+      ".#{@name}(#{stringified_arguments})"
+    end
 
-      stringified_items = []
-      stringified_items << stringified_args   unless @args.empty?
-      stringified_items << stringified_opts   unless @opts.empty?
-      stringified_items << stringified_block  unless @block.nil?
+    private
 
-      "#{string}(#{stringified_items.join(", ")})"
+    def no_arguments?
+      @args.empty? && @opts.empty? && @block.nil?
     end
 
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/CyclomaticComplexity
+    def stringified_arguments
+      [
+        args_string,
+        opts_string,
+        block_string
+      ].compact.join(", ")
+    end
 
-    # Returns a human-readable representation of the method.
-    #
-    # @example
-    #   add = Defi::Method.new(:+, 1)
-    #   add.inspect # => "Defi(name: :+, args: [1], opts: {}, block: nil)"
-    #
-    # @return [String] The human-readable representation of the method.
-    def inspect
-      inspected_name  = @name.inspect
-      inspected_args  = @args.inspect
-      inspected_opts  = @opts.inspect
-      inspected_block = @block.nil? ? "nil" : "<Proc>"
+    def args_string
+      @args.inspect[1..-2] unless @args.empty?
+    end
 
-      "Defi(" \
-        "name: #{inspected_name}, " \
-        "args: #{inspected_args}, " \
-        "opts: #{inspected_opts}, " \
-        "block: #{inspected_block})"
+    def opts_string
+      @opts.inspect[1..-2] unless @opts.empty?
+    end
+
+    def block_string
+      "<Proc>" if @block
     end
   end
 end

data/lib/defi/value.rb

@@ -1,93 +1,83 @@
 # frozen_string_literal: true
 
 module Defi
-  # Represents a result of an operation, encapsulating either the returned value
-  # or an exception raised during the execution.
-  #
-  # This class is used to handle the outcome of a method invocation, allowing
-  # to distinguish between successful results and exceptions.
+  # Represents a result of an operation, encapsulating both successful returns
+  # and exceptions. This class intentionally catches all exceptions (Exception)
+  # instead of StandardError to maintain complete control over method execution
+  # outcomes, particularly in testing contexts. This ensures that system-level
+  # exceptions like SystemExit cannot prematurely terminate test execution with
+  # potentially false positive results.
   class Value
     RAISE = "raise"
     RETURN = "return"
 
-    # @return [#object_id] The returned or the raised object.
+    # @return [#object_id] The returned value or caught exception
     attr_reader :object
 
-    # Initializes a Value object with the result of the provided block.
-    # Captures any exception raised during the block execution.
+    # Initializes a Value object by executing the provided block.
     #
-    # @example
+    # @example Successful execution
     #   value = Defi::Value.new { 1 + 1 }
     #   value.call # => 2
+    #   value.raised? # => false
     #
-    # @example Handling an exception
-    #   value = Defi::Value.new { raise 'Error' }
-    #   value.call # raises 'Error'
+    # @example Exception handling
+    #   value = Defi::Value.new { raise TypeError, "Invalid type" }
+    #   value.raised? # => true
+    #   value.object # => #<TypeError: Invalid type>
+    #
+    # @note This implementation catches Exception instead of StandardError
+    #   to provide complete control over method execution outcomes,
+    #   including system-level exceptions when needed.
     #
-    # @yieldreturn [#object_id] The result of the block or the exception raised.
-    # rubocop:disable Lint/RescueException
+    # @yieldreturn [#object_id] Result or exception from block execution
     def initialize
       @object = yield
       @raised = false
-    rescue ::Exception => e
+    rescue ::Exception => e # rubocop:disable Lint/RescueException
       @object = e
       @raised = true
     end
-    # rubocop:enable Lint/RescueException
 
-    # Returns the object if no exception was raised, otherwise raises the exception.
+    # Returns the result or raises the captured exception.
+    #
+    # @example With successful result
+    #   Value.new { "success" }.call # => "success"
     #
-    # @example
-    #   value = Defi::Value.new { "Hello" }
-    #   value.call # => "Hello"
+    # @example With exception
+    #   Value.new { raise "error" }.call # raises RuntimeError: error
     #
-    # @return [#object_id] The returned object or raises the captured exception.
+    # @return [#object_id] The operation result
+    # @raise [Exception] The captured exception if raised? is true
     def call
       raise object if raised?
 
       object
     end
 
-    # Checks if an exception was raised during the execution.
-    #
-    # @example
-    #   value = Defi::Value.new { raise 'Error' }
-    #   value.raised? # => true
-    #
-    # @return [Boolean] True if an exception was raised, otherwise false.
+    # @return [Boolean] true if execution raised an exception
     def raised?
       @raised
     end
 
-    # Returns a hash containing the properties of the Value object.
-    #
-    # @return [Hash] The properties of the Value object.
+    # @return [String] Human-readable representation
+    def inspect
+      "Value(object: #{object}, raised: #{raised?})"
+    end
+
+    # @return [Hash] Value properties
     def to_h
-      {
-        raised: raised?,
-        object:
-      }
+      { raised: raised?, object: }
     end
 
-    # Returns a string representation of the Value object.
-    #
-    # @return [String] The string representation of the Value object.
+    # @return [String] String representation showing outcome type and value
     def to_s
       "#{raise_or_return} #{object}"
     end
 
-    # Returns a human-readable representation of the Value object.
-    #
-    # @return [String] The human-readable representation of the Value object.
-    def inspect
-      "Value(object: #{object}, raised: #{raised?})"
-    end
-
     private
 
-    # Returns a string indicating whether the object was raised or returned.
-    #
-    # @return [String] A "raise" or "return" string.
+    # @return [String] Execution outcome type
     def raise_or_return
       raised? ? RAISE : RETURN
     end

data/lib/defi.rb

@@ -2,27 +2,33 @@
 
 # Namespace for the Defi library.
 #
-# This file serves as the entry point for the Defi library, establishing the
-# Defi namespace and requiring necessary components.  It is typically required
-# at the beginning of using the Defi library in an application.
+# Defi provides a flexible way to specify method calls with arguments
+# for later execution. It supports method chaining, exception handling,
+# and value inspection.
 #
-# @example Requiring the Defi library in a Ruby application
-#   require "defi"
-#
-# @example Adding 2 to 1
-#   # Create a Defi method object for addition with an argument of 2
+# @example Basic arithmetic operation
 #   addition = Defi(:+, 2)
-#   addition.inspect # => "Defi(name: :+, args: [2], opts: {}, block: nil)"
+#   addition.to(1).call # => 3
+#
+# @example String manipulation
+#   upcase = Defi(:upcase)
+#   upcase.to("hello").call # => "HELLO"
+#
+# @example Method with keyword arguments
+#   format = Defi(:format, precision: 2)
+#   format.to(3.14159).call # => "3.14"
 #
-#   # Apply the addition to the number 1
-#   result = addition.to(1)
-#   result # => Value(object: 3, raised: false)
+# @example Block usage
+#   map_double = Defi(:map) { |x| x * 2 }
+#   map_double.to([1, 2, 3]).call # => [2, 4, 6]
 #
-#   # Execute the addition and get the result
-#   result.call # => 3
+# @example Error handling
+#   result = Defi(:undefined_method).to(42)
+#   result.raised? # => true
+#   result.object # => #<NoMethodError: ...>
 #
 module Defi
 end
 
-# Require additional components of the Defi library.
+# Load core components
 require_relative "kernel"

data/lib/kernel.rb

@@ -2,41 +2,44 @@
 
 require_relative File.join("defi", "method")
 
-# Extension of the Kernel module to include the Defi method.
-# The Defi method is a convenient way to create Method objects
-# that encapsulate a method name and its arguments, offering a
-# dynamic approach to method invocation.
+# Core Ruby module extended to provide the Defi method globally.
+# This extension allows for convenient method encapsulation and
+# delayed execution through the Defi method, accessible anywhere
+# in the Ruby environment.
 module Kernel
-  # Disabling the RuboCop rule for method naming conventions
-  # to define a method with an uppercase name for stylistic reasons.
   # rubocop:disable Naming/MethodName
 
   # Creates a new Defi::Method instance.
-  # This method provides a simple and elegant way to encapsulate
-  # a method name and its arguments for later invocation.
+  # This method provides a flexible way to encapsulate a method name along with its
+  # arguments, keyword arguments, and an optional block for later invocation.
   #
-  # @example Creating a Defi method without arguments
-  #   Defi(:foo).inspect # => "Defi(name: :foo, args: [], opts: {}, block: nil)"
+  # @param method_name [Symbol] The method name to be sent to an object
+  # @param args [Array] Positional arguments to be passed to the method
+  # @param opts [Hash] Keyword arguments to be passed to the method
+  # @param block [Proc] Optional block to be passed to the method
   #
-  # @example Adding 2 to 1
-  #   # Create a Defi method object for addition with an argument of 2
-  #   addition = Defi(:+, 2)
-  #   addition.inspect # => "Defi(name: :+, args: [2], opts: {}, block: nil)"
+  # @example Basic method without arguments
+  #   Defi(:to_s)
   #
-  #   # Apply the addition to the number 1
-  #   result = addition.to(1)
-  #   result # => Value(object: 3, raised: false)
+  # @example Method with positional arguments
+  #   Defi(:+, 2)
+  #   Defi(:[], 0, 2)  # For array/string slicing
   #
-  #   # Execute the addition and get the result
-  #   result.call # => 3
+  # @example Method with keyword arguments
+  #   Defi(:transform, x: 1, y: 2)
   #
-  # @param method_name [Symbol] The method name to be sent to an object.
+  # @example Method with a block
+  #   Defi(:map) { |x| x * 2 }
   #
-  # @return [Defi::Method] An instance of Defi::Method encapsulating the method name and provided arguments.
-  def Defi(method_name, ...)
-    ::Defi::Method.new(method_name, ...)
+  # @example Complex method call
+  #   Defi(:reduce, 0, &:+)  # Sum an array
+  #
+  # @raise [ArgumentError] If method_name is not a Symbol
+  #
+  # @return [Defi::Method] An instance of Defi::Method encapsulating the method call
+  def Defi(method_name, *args, **opts, &block)
+    ::Defi::Method.new(method_name, *args, **opts, &block)
   end
 
-  # Re-enabling the RuboCop rule for method naming conventions.
   # rubocop:enable Naming/MethodName
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Cyril Kato
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies: []
 description: Challenge library.
 email: contact@cyril.email
@@ -27,7 +27,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -35,15 +35,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Challenge library.
 test_files: []