ruby_arguments 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00dd9a3e3642d15c066c4fb124c69e2252590e95f8756747e9eb09f2746aa9c7
-  data.tar.gz: 459b704c14888e6cd736576b6dbe1bea6113a7d2eefa13a50f332c89e480eeaf
+  metadata.gz: 797ac853f48f6fff8bf279034396df2871e32a8262a61bb4fe2dcc48a18470c4
+  data.tar.gz: f915acf7426c33d210252862f78f6122e4f6c33a02b2d10d21b0eaed1bab28e9
 SHA512:
-  metadata.gz: e98906719edca259ff5c5b6220134bcda5396dba5d78ef0c3b81d0c4411ef0f109ae6e1478009279d97f195c0672872f2ce22483d87ff04dd6ef388feb28419d
-  data.tar.gz: bb3e69d95db037f81da620128f0d0763f4ef177669ace0d25b6a47b239d0173fc9f472c6c22811894abeece3d4c73d43305757820d9d41907ae8eb7be264c075
+  metadata.gz: 00bc1e115f3170671790ae88af6ed09faf660f860264140a752087219e8ec29243b2f870d3139224e3ed246a90a9ab16e52d241f77b1c545dac271b53c2f98b9
+  data.tar.gz: 8a90564da79c936954d46b51199bfbf16deb15e09166cb3c9d26d664e832c610f591923c8746ddc83bed8d7961a3b829dc215f795e115cbf7e5101a0317e3b6f

data/README.md

@@ -8,7 +8,7 @@
 [![Gem Version](https://badge.fury.io/rb/ruby_arguments.svg)](https://rubygems.org/gems/ruby_arguments) [![Gem Downloads](https://img.shields.io/gem/dt/ruby_arguments.svg)](https://rubygems.org/gems/ruby_arguments)  ![GitHub repo size](https://img.shields.io/github/repo-size/marian13/ruby_arguments) [![GitHub Actions CI](https://github.com/marian13/ruby_arguments/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/marian13/ruby_arguments/actions/workflows/ci.yml) [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard) [![Coverage Status](https://coveralls.io/repos/github/marian13/ruby_arguments/badge.svg)](https://coveralls.io/github/marian13/ruby_arguments?branch=main) [![yard docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://marian13.github.io/ruby_arguments)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Ruby Arguments encapsulate method positional arguments (`args`), keyword arguments (`kwargs`), and an optional block (`block`) in a single value object (null object is also available).
+Ruby Arguments encapsulate method positional arguments (`args`), keyword arguments (`kwargs`), and an optional block (`block`) in a single value object ([null object](https://refactoring.guru/introduce-null-object) is also available).
 
 That may be useful for DSLs, caches, callbacks, custom RSpec matchers, hash keys, pattern matching and so on.
 
@@ -45,7 +45,7 @@ arguments.kwargs
 arguments.block
 # => #<Proc:0x000000012a97fc18>
 
-arguments.null_arguments?
+arguments.null_arguments? # Or an alias `arguments.nil_arguments?`.
 # => false
 
 arguments.any?
@@ -117,4 +117,4 @@ gem install ruby_arguments
 
 ---
 
-Copyright (c) 2025 Marian Kostyk.
+Copyright (c) 2025-2026 Marian Kostyk.

data/lib/ruby_arguments/version.rb

@@ -6,5 +6,10 @@
 ##
 
 class RubyArguments
-  VERSION = "1.0.0"
+  ##
+  # @api public
+  # @since 1.1.0
+  # @return [String]
+  #
+  VERSION = "1.1.0"
 end

data/lib/ruby_arguments.rb

@@ -5,11 +5,25 @@
 # @license MIT <https://opensource.org/license/mit>
 ##
 
+require_relative "ruby_arguments/version"
+
+##
+# @api public
+# @since 1.0.0
+#
 class RubyArguments
   module Exceptions
+    ##
+    # @api public
+    # @since 1.0.0
+    #
     class Base < ::StandardError
     end
 
+    ##
+    # @api public
+    # @since 1.0.0
+    #
     class InvalidKeyType < Base
       class << self
         ##
@@ -30,6 +44,10 @@ class RubyArguments
     end
   end
 
+  ##
+  # @api public
+  # @since 1.0.0
+  #
   class NullArguments < ::RubyArguments
     ##
     # @api private
@@ -43,15 +61,27 @@ class RubyArguments
 
     ##
     # @api public
+    # @since 1.0.0
     # @return [Boolean]
     #
     def null_arguments?
       true
     end
+
+    ##
+    # @api public
+    # @since 1.1.0
+    # @return [Boolean]
+    #
+    # @note Original pattern is called Null Object. Since Ruby has `nil` instead of `null` this alias is introduced.
+    # @see https://refactoring.guru/introduce-null-object
+    #
+    alias_method :nil_arguments?, :null_arguments?
   end
 
   ##
   # @api public
+  # @since 1.0.0
   # @!attribute [r] args
   #   @return [Array<Object>]
   #
@@ -59,6 +89,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @!attribute [r] kwargs
   #   @return [Hash{Symbol => Object}]
   #
@@ -66,6 +97,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @!attribute [r] block
   #   @return [Proc, nil]
   #
@@ -73,6 +105,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @param args [Array<Object>]
   # @param kwargs [Hash{Symbol => Object}]
   # @param block [Proc, nil]
@@ -87,15 +120,27 @@ class RubyArguments
   class << self
     ##
     # @api public
+    # @since 1.0.0
     # @return [RubyArguments::NullArguments]
     #
     def null_arguments
       @null_arguments ||= ::RubyArguments::NullArguments.new
     end
+
+    ##
+    # @api public
+    # @since 1.1.0
+    # @return [RubyArguments::NullArguments]
+    #
+    # @note Original pattern is called Null Object. Since Ruby has `nil` instead of `null` this alias is introduced.
+    # @see https://refactoring.guru/introduce-null-object
+    #
+    alias_method :nil_arguments, :null_arguments
   end
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Boolean]
   #
   def null_arguments?
@@ -104,6 +149,17 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.1.0
+  # @return [Boolean]
+  #
+  # @note Original pattern is called Null Object. Since Ruby has `nil` instead of `null` this alias is introduced.
+  # @see https://refactoring.guru/introduce-null-object
+  #
+  alias_method :nil_arguments?, :null_arguments?
+
+  ##
+  # @api public
+  # @since 1.0.0
   # @return [Booleam]
   #
   def any?
@@ -116,6 +172,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Booleam]
   #
   def none?
@@ -124,6 +181,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Booleam]
   #
   def empty?
@@ -132,6 +190,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Booleam]
   #
   def present?
@@ -140,6 +199,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Booleam]
   #
   def blank?
@@ -148,6 +208,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @param key [Integer, Symbol]
   # @return [Object] Can be any type.
   # @raise [RubyArguments::Exceptions::InvalidKeyType]
@@ -162,6 +223,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @param other [Object] Can be any type.
   # @return [Boolean, nil]
   #
@@ -177,6 +239,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @param other [Object] Can be any type.
   # @return [Boolean, nil]
   #
@@ -192,6 +255,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Integer]
   #
   def hash
@@ -200,6 +264,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @return [Array]
   #
   def deconstruct
@@ -208,6 +273,7 @@ class RubyArguments
 
   ##
   # @api public
+  # @since 1.0.0
   # @param keys [Array<Symbol>, nil]
   # @return [Hash]
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_arguments
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Marian Kostyk