semantic_boolean 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3d9c2076d58203acfd4d286c8f0491a0403585af352e12a3f1477e0d3bd8d0a
-  data.tar.gz: 66dc456ae946024cee15a33d91fb87af31d191d05760178095e4a32850bd2e5e
+  metadata.gz: '09cb6dcc37df8d9dde36fb8b1a37deeb870c6ac0ab23e4abde43480382fdc39c'
+  data.tar.gz: 5882eb02b040245ceb4d5a53e76e1babd2ed5018f43cf9f0468b5f27d9b4d17d
 SHA512:
-  metadata.gz: 041dc449b3a8cf4d47cb3d4c97782d0cb7af6f4282e5a2c4e075d74d57d68c7843d1645bb6901a18e7866af1a6e03833e6958ee063ab202ce3a46e9616feb81f
-  data.tar.gz: 8912adf0a5e985ddea2141db7906e72b541f226fed6fce0cb6e3ac0486d61021924ef19bc0adec75ad48a4c875d8925dca9a4946bf6d60c98e6bdc3052232bdd
+  metadata.gz: bb2415e230f8ef2219d484b62024f7e852cbed327547f1308de43a4e5a8c17f17a8878089c0ce68f87b3f323a0771953a17a1ed71e4e18ac7d1d880bc24b1a64
+  data.tar.gz: '06118a027f5b550d55efe2f6cfae55ed8b91f68f1b159d71ac8af098de010adb8fa90aed31e68c93f2e59575e9923a8404f7b61d8ee1c870121358b1c4952070'

data/README.md

@@ -1,3 +1,6 @@
+<!-- AUTHOR: Marian Kostyk <mariankostyk13895@gmail.com> -->
+<!-- LICENSE: MIT <https://opensource.org/license/mit> -->
+
 # Semantic Boolean
 
 [![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)](https://www.ruby-lang.org/en/)
@@ -56,6 +59,24 @@ SemanticBoolean.blank?(any_object)
 SemanticBoolean.present?(any_object)
 # => true or false
 
+##
+# Returns `true` only when object is `true` or `false`.
+#
+SemanticBoolean.boolean?(any_object)
+# => true or false
+
+##
+# Returns `true` only when object is `true`.
+#
+SemanticBoolean.true?(any_object)
+# => true or false
+
+##
+# Returns `true` only when object is `false`.
+#
+SemanticBoolean.false?(any_object)
+# => true or false
+
 ##
 # The following methods do not return boolean values, but they are often utilized in a boolean context.
 ##
@@ -139,3 +160,7 @@ SKIP_AUTH=no
 ```
 
 To the Rails team. They made me a Ruby dev who can't live without Rails goodies in the non-Rails projects.
+
+---
+
+Copyright (c) 2025 Marian Kostyk.

data/lib/semantic_boolean/version.rb

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

data/lib/semantic_boolean.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license MIT <https://opensource.org/license/mit>
+##
+
 require_relative "semantic_boolean/version"
 
 require "set"
@@ -10,6 +15,7 @@ module SemanticBoolean
     ##
     # Truthy values in `SemanticBoolean.to_env_bool` terms.
     #
+    # @api private
     # @return [Array<String>]
     #
     TO_ENV_BOOL_TRUE_VALUES = ["t", "T", "true", "True", "TRUE", "on", "On", "ON", "y", "Y", "yes", "Yes", "YES"].freeze
@@ -17,6 +23,7 @@ module SemanticBoolean
     ##
     # Falsy values in `ActiveModel::Type::Boolean` terms.
     #
+    # @api private
     # @return [Array<String>]
     #
     # @see https://github.com/rails/rails/blob/v8.0.2/activemodel/lib/active_model/type/boolean.rb#L15
@@ -26,6 +33,7 @@ module SemanticBoolean
     ##
     # Regexp to match falsy string values in Rails `blank?` terms.
     #
+    # @api private
     # @return [Regexp]
     #
     # @see https://github.com/rails/rails/blob/v8.0.2/activesupport/lib/active_support/core_ext/object/blank.rb#L136
@@ -35,6 +43,7 @@ module SemanticBoolean
     ##
     # Cache of regexp objects to match falsy string values in Rails `blank?` terms with non-default encodings.
     #
+    # @api private
     # @return [Hash]
     #
     # @see https://github.com/rails/rails/blob/v8.0.2/activesupport/lib/active_support/core_ext/object/blank.rb#L137
@@ -43,11 +52,164 @@ module SemanticBoolean
       h[enc] = ::Regexp.new(ACTIVE_SUPPORT_CORE_EXT_BLANK_RE.source.encode(enc), ACTIVE_SUPPORT_CORE_EXT_BLANK_RE.options | ::Regexp::FIXEDENCODING)
     end
 
+    ##
+    # Returns `true` when `object` is `true` or `false`, returns `false` for all the other cases.
+    # @api public
+    # @since 1.1.0
+    # @param object [Object] Can be any type.
+    # @return [Boolean]
+    #
+    def boolean?(object)
+      return true if object == true
+      return true if object == false
+
+      false
+    end
+
+    ##
+    # Returns `true` when `object` is `true`, returns `false` for all the other cases.
+    # @api public
+    # @since 1.1.0
+    # @param object [Object] Can be any type.
+    # @return [Boolean]
+    #
+    def true?(object)
+      return true if object == true
+
+      false
+    end
+
+    ##
+    # Returns `true` when `object` is `false`, returns `false` for all the other cases.
+    # @api public
+    # @since 1.1.0
+    # @param object [Object] Can be any type.
+    # @return [Boolean]
+    #
+    def false?(object)
+      return true if object == false
+
+      false
+    end
+
+    ##
+    # Converts `object` to boolean using exactly the same logic as `blank?` in Rails does (but with `Hash` instead of `Concurent::Map` for string encodings storage).
+    #
+    # @api public
+    # @since 1.0.0
+    # @param object [Object] Can be any type.
+    # @return [Boolean]
+    #
+    # @note If performance is a concern, prefer to load Rails (or just `activesupport`) and use `blank?` directly.
+    # @see https://api.rubyonrails.org/classes/Object.html#method-i-blank-3F
+    # @see https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html#method-i-blank-3F
+    # @see https://api.rubyonrails.org/classes/ActiveRecord/Relation.html#method-i-blank-3F
+    #
+    def blank?(object)
+      respond_to_blank =
+        begin
+          object.respond_to?(:blank?)
+        rescue ::NoMethodError
+          object.blank? # Only `BasicObject` does NOT respond to `respond_to?`.
+        end
+
+      return object.__send__(:blank?) if respond_to_blank
+
+      case object
+      when ::NilClass
+        true
+      when ::FalseClass
+        true
+      when ::TrueClass
+        false
+      when ::Array
+        object.empty?
+      when ::Hash
+        object.empty?
+      when ::Symbol
+        object.empty?
+      when ::String
+        object.empty? ||
+          begin
+            ACTIVE_SUPPORT_CORE_EXT_BLANK_RE.match?(object)
+          rescue ::Encoding::CompatibilityError
+            ACTIVE_SUPPORT_CORE_EXT_ENCODED_BLANKS[object.encoding].match?(object)
+          end
+      when ::Numeric
+        false
+      when ::Time
+        false
+      when ::Object
+        object.respond_to?(:empty?) ? !!object.empty? : false
+      else
+        object.blank?
+      end
+    end
+
+    ##
+    # Converts `object` to boolean using exactly the same logic as `present?` in Rails does (but with `Hash` instead of `Concurent::Map` for string encodings storage).
+    #
+    # @api public
+    # @since 1.0.0
+    # @param object [Object] Can be any type.
+    # @return [Boolean]
+    #
+    # @note If performance is a concern, prefer to load Rails (or just `activesupport`) and use `present?` directly.
+    # @see https://api.rubyonrails.org/classes/Object.html#method-i-present-3F
+    #
+    def present?(object)
+      respond_to_present =
+        begin
+          object.respond_to?(:present?)
+        rescue ::NoMethodError
+          object.present? # Only `BasicObject` does NOT respond to `respond_to?`.
+        end
+
+      return object.__send__(:present?) if respond_to_present
+      return !object.__send__(:blank?) if object.respond_to?(:blank?)
+
+      case object
+      when ::NilClass
+        false
+      when ::FalseClass
+        false
+      when ::TrueClass
+        true
+      when ::Array
+        !object.empty?
+      when ::Hash
+        !object.empty?
+      when ::Symbol
+        !object.empty?
+      when ::String
+        !(
+          object.empty? ||
+            begin
+              ACTIVE_SUPPORT_CORE_EXT_BLANK_RE.match?(object)
+            rescue ::Encoding::CompatibilityError
+              ACTIVE_SUPPORT_CORE_EXT_ENCODED_BLANKS[object.encoding].match?(object)
+            end
+        )
+      when ::Numeric
+        true
+      when ::Time
+        true
+      when ::Object
+        !(
+          object.respond_to?(:empty?) ? !!object.empty? : false
+        )
+      else
+        object.present?
+      end
+    end
+
     ##
     # Returns `false` when `object` is `false` or `nil`.
     # Returns `true` for all the other cases.
     # Just like Ruby does in the control expressions.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @return [Boolean]
     #
@@ -61,6 +223,8 @@ module SemanticBoolean
     ##
     # A handy alias for `to_ruby_bool`.
     #
+    # @api public
+    # @since 1.0.0
     # @return [Boolean]
     #
     alias_method :to_bool, :to_ruby_bool
@@ -72,6 +236,8 @@ module SemanticBoolean
       # - If yes, returns `true`, otherwise it converts `object` to an integer by `Kernel.Integer` and checks whether it is greater than zero.
       # - If yes, returns `true`, otherwise returns `false`.
       #
+      # @api public
+      # @since 1.0.0
       # @param object [Object] Can be any type.
       # @return [Boolean]
       #
@@ -97,6 +263,8 @@ module SemanticBoolean
       # - If yes, returns `true`, otherwise it converts `object` to an integer by `Kernel.Integer` and checks whether it is greater than zero.
       # - If yes, returns `true`, otherwise returns `false`.
       #
+      # @api public
+      # @since 1.0.0
       # @param object [Object] Can be any type.
       # @return [Boolean]
       #
@@ -124,67 +292,11 @@ module SemanticBoolean
       # rubocop:enable Lint/SuppressedExceptionInNumberConversion
     end
 
-    ##
-    # Converts `object` to boolean using exactly the same logic as `blank?` in Rails does (but with `Hash` instead of `Concurent::Map` for string encodings storage).
-    #
-    # @param object [Object] Can be any type.
-    # @return [Boolean]
-    #
-    # @note If performance is a concern, prefer to load Rails (or just `activesupport`) and use `blank?` directly.
-    # @see https://api.rubyonrails.org/classes/Object.html#method-i-blank-3F
-    # @see https://api.rubyonrails.org/classes/ActiveSupport/TimeWithZone.html#method-i-blank-3F
-    # @see https://api.rubyonrails.org/classes/ActiveRecord/Relation.html#method-i-blank-3F
-    #
-    def blank?(object)
-      return object.__send__(:blank?) if object.respond_to?(:blank?)
-
-      case object
-      when NilClass
-        true
-      when FalseClass
-        true
-      when TrueClass
-        false
-      when Array
-        object.empty?
-      when Hash
-        object.empty?
-      when Symbol
-        object.empty?
-      when String
-        object.empty? ||
-          begin
-            ACTIVE_SUPPORT_CORE_EXT_BLANK_RE.match?(object)
-          rescue ::Encoding::CompatibilityError
-            ACTIVE_SUPPORT_CORE_EXT_ENCODED_BLANKS[object.encoding].match?(object)
-          end
-      when Numeric
-        false
-      when Time
-        false
-      when Object
-        object.respond_to?(:empty?) ? !!object.empty? : false
-      else
-        object.__send__(:blank?)
-      end
-    end
-
-    ##
-    # Converts `object` to boolean using exactly the same logic as `present?` in Rails does (but with `Hash` instead of `Concurent::Map` for string encodings storage).
-    #
-    # @param object [Object] Can be any type.
-    # @return [Boolean]
-    #
-    # @note If performance is a concern, prefer to load Rails (or just `activesupport`) and use `present?` directly.
-    # @see https://api.rubyonrails.org/classes/Object.html#method-i-present-3F
-    #
-    def present?(object)
-      !blank?(object)
-    end
-
     ##
     # Converts `object` to boolean (or `nil`) using exactly the same logic as `ActiveModel::Type::Boolean.new.cast(object)` does.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @return [Boolean, nil]
     #
@@ -202,6 +314,8 @@ module SemanticBoolean
     # Accepts optional `:by` keyword to rely on a different method.
     # Accepts optional `:unknown` keyword that specify what to return when `object` is `nil`.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @param by [Symbol, String].
     # @param unknown [Object] Can be any type.
@@ -231,6 +345,8 @@ module SemanticBoolean
     # Accepts optional `:by` keyword to rely on a different method.
     # Accepts optional `:unknown` keyword that specify what to return when `object` is `nil`.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @param by [Symbol, String].
     # @param unknown [Object] Can be any type.
@@ -260,6 +376,8 @@ module SemanticBoolean
     # Accepts optional `:by` keyword to rely on a different method.
     # Accepts optional `:unknown` keyword that specify what to return when `object` is `nil`.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @param by [Symbol, String].
     # @param unknown [Object] Can be any type.
@@ -289,6 +407,8 @@ module SemanticBoolean
     # Accepts optional `:by` keyword to rely on a different method.
     # Accepts optional `:unknown` keyword that specify what to return when `object` is `nil`.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @param by [Symbol, String].
     # @param unknown [Object] Can be any type.
@@ -318,6 +438,8 @@ module SemanticBoolean
     # Accepts optional `:by` keyword to rely on a different method.
     # Accepts optional `:unknown` keyword that specify what to return when `object` is `nil`.
     #
+    # @api public
+    # @since 1.0.0
     # @param object [Object] Can be any type.
     # @param by [Symbol, String].
     # @param unknown [Object] Can be any type.

metadata

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