ruby_arguments 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00dd9a3e3642d15c066c4fb124c69e2252590e95f8756747e9eb09f2746aa9c7
+  data.tar.gz: 459b704c14888e6cd736576b6dbe1bea6113a7d2eefa13a50f332c89e480eeaf
+SHA512:
+  metadata.gz: e98906719edca259ff5c5b6220134bcda5396dba5d78ef0c3b81d0c4411ef0f109ae6e1478009279d97f195c0672872f2ce22483d87ff04dd6ef388feb28419d
+  data.tar.gz: bb3e69d95db037f81da620128f0d0763f4ef177669ace0d25b6a47b239d0173fc9f472c6c22811894abeece3d4c73d43305757820d9d41907ae8eb7be264c075

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marian Kostyk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+<!-- AUTHOR: Marian Kostyk <mariankostyk13895@gmail.com> -->
+<!-- LICENSE: MIT <https://opensource.org/license/mit> -->
+
+# Ruby Arguments
+
+[![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)](https://www.ruby-lang.org/en/)
+
+[![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).
+
+That may be useful for DSLs, caches, callbacks, custom RSpec matchers, hash keys, pattern matching and so on.
+
+The initial Ruby Arguments implementation was extracted from the [Convenient Service](https://github.com/marian13/convenient_service).
+
+## TL;DR
+
+```ruby
+require "ruby_arguments"
+
+def some_method(*args, **kwargs, &block)
+  RubyArguments.new(*args, **kwargs, &block)
+end
+
+##
+# Or shorter from Ruby 2.7.
+#
+def some_method(...)
+  RubyArguments.new(...)
+end
+
+args = [:foo, :bar]
+kwargs = {foo: :bar, baz: :qux}
+block = proc { :foo }
+
+arguments = some_method(*args, **kwargs, &block)
+
+arguments.args
+# => [:foo, :bar]
+
+arguments.kwargs
+# => {foo: :bar, baz: :qux}
+
+arguments.block
+# => #<Proc:0x000000012a97fc18>
+
+arguments.null_arguments?
+# => false
+
+arguments.any?
+# => true
+
+arguments.none?
+# => false
+
+arguments.empty?
+# => false
+
+arguments.present?
+# => true
+
+arguments.blank?
+# => false
+
+arguments[0]
+# => :foo
+
+arguments[:foo]
+# => :bar
+
+def some_other_method
+  RubyArguments.null_arguments
+end
+
+null_arguments = some_other_method
+
+null_arguments.null_arguments?
+# => true
+
+arguments == null_arguments
+# => false
+
+arguments.eql?(null_arguments)
+# => false
+
+arguments in [args, kwargs, block]
+# => true
+
+arguments in args:, kwargs:, :block
+# => true
+```
+
+## Installation
+
+### Bundler
+
+Add the following line to your Gemfile:
+
+```ruby
+gem "ruby_arguments"
+```
+
+And then run:
+
+```bash
+bundle install
+```
+
+### Without Bundler
+
+Execute the command below:
+
+```bash
+gem install ruby_arguments
+```
+
+---
+
+Copyright (c) 2025 Marian Kostyk.

data/lib/ruby_arguments/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license MIT <https://opensource.org/license/mit>
+##
+
+class RubyArguments
+  VERSION = "1.0.0"
+end

data/lib/ruby_arguments.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license MIT <https://opensource.org/license/mit>
+##
+
+class RubyArguments
+  module Exceptions
+    class Base < ::StandardError
+    end
+
+    class InvalidKeyType < Base
+      class << self
+        ##
+        # @api private
+        # @param key [Object] Can be any type.
+        # @return [RubyArguments::Exceptions::InvalidKeyType]
+        #
+        def create(key:)
+          message = <<~TEXT
+            `#[]` accepts only `Integer` and `String` keys.
+
+            Key `#{key.inspect}` has `#{key.class}` class.
+          TEXT
+
+          new(message)
+        end
+      end
+    end
+  end
+
+  class NullArguments < ::RubyArguments
+    ##
+    # @api private
+    # @return [void]
+    #
+    def initialize
+      @args = []
+      @kwargs = {}
+      @block = nil
+    end
+
+    ##
+    # @api public
+    # @return [Boolean]
+    #
+    def null_arguments?
+      true
+    end
+  end
+
+  ##
+  # @api public
+  # @!attribute [r] args
+  #   @return [Array<Object>]
+  #
+  attr_reader :args
+
+  ##
+  # @api public
+  # @!attribute [r] kwargs
+  #   @return [Hash{Symbol => Object}]
+  #
+  attr_reader :kwargs
+
+  ##
+  # @api public
+  # @!attribute [r] block
+  #   @return [Proc, nil]
+  #
+  attr_reader :block
+
+  ##
+  # @api public
+  # @param args [Array<Object>]
+  # @param kwargs [Hash{Symbol => Object}]
+  # @param block [Proc, nil]
+  # @return [void]
+  #
+  def initialize(*args, **kwargs, &block)
+    @args = args
+    @kwargs = kwargs
+    @block = block
+  end
+
+  class << self
+    ##
+    # @api public
+    # @return [RubyArguments::NullArguments]
+    #
+    def null_arguments
+      @null_arguments ||= ::RubyArguments::NullArguments.new
+    end
+  end
+
+  ##
+  # @api public
+  # @return [Boolean]
+  #
+  def null_arguments?
+    false
+  end
+
+  ##
+  # @api public
+  # @return [Booleam]
+  #
+  def any?
+    return true if args.any?
+    return true if kwargs.any?
+    return true if block
+
+    false
+  end
+
+  ##
+  # @api public
+  # @return [Booleam]
+  #
+  def none?
+    !any?
+  end
+
+  ##
+  # @api public
+  # @return [Booleam]
+  #
+  def empty?
+    none?
+  end
+
+  ##
+  # @api public
+  # @return [Booleam]
+  #
+  def present?
+    any?
+  end
+
+  ##
+  # @api public
+  # @return [Booleam]
+  #
+  def blank?
+    none?
+  end
+
+  ##
+  # @api public
+  # @param key [Integer, Symbol]
+  # @return [Object] Can be any type.
+  # @raise [RubyArguments::Exceptions::InvalidKeyType]
+  #
+  def [](key)
+    case key
+    when ::Integer then args[key]
+    when ::Symbol then kwargs[key]
+    else raise Exceptions::InvalidKeyType.create(key: key)
+    end
+  end
+
+  ##
+  # @api public
+  # @param other [Object] Can be any type.
+  # @return [Boolean, nil]
+  #
+  def ==(other)
+    return unless other.instance_of?(self.class)
+
+    return false if args != other.args
+    return false if kwargs != other.kwargs
+    return false if block != other.block
+
+    true
+  end
+
+  ##
+  # @api public
+  # @param other [Object] Can be any type.
+  # @return [Boolean, nil]
+  #
+  def eql?(other)
+    return unless other.instance_of?(self.class)
+
+    return false if args != other.args
+    return false if kwargs != other.kwargs
+    return false if block != other.block
+
+    true
+  end
+
+  ##
+  # @api public
+  # @return [Integer]
+  #
+  def hash
+    [self.class, args, kwargs, block].hash
+  end
+
+  ##
+  # @api public
+  # @return [Array]
+  #
+  def deconstruct
+    [args, kwargs, block]
+  end
+
+  ##
+  # @api public
+  # @param keys [Array<Symbol>, nil]
+  # @return [Hash]
+  #
+  def deconstruct_keys(keys)
+    keys ||= [:args, :kwargs, :block]
+
+    keys.each_with_object({}) do |key, hash|
+      case key
+      when :args
+        hash[key] = args
+      when :kwargs
+        hash[key] = kwargs
+      when :block
+        hash[key] = block
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: ruby_arguments
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marian Kostyk
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 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).
+email:
+- mariankostyk13895@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/ruby_arguments.rb
+- lib/ruby_arguments/version.rb
+homepage: https://github.com/marian13/ruby_arguments
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/marian13/ruby_arguments
+  source_code_uri: https://github.com/marian13/ruby_arguments
+  changelog_uri: https://github.com/marian13/ruby_arguments/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: 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).
+test_files: []