to_be 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cad135b7c9f7014fe409c78f79db0b17a83245bbaa8fa907cc45b8b8fc3891d
+  data.tar.gz: 8f551d45b01ee0c1cbd6894d61d5d06f9e811689e8803df272d5594a9e5fe716
+SHA512:
+  metadata.gz: b7591524247b3a9701468833511c4afcc5ed1f0a19354e7bbd3797edfdd8ace33b6a7cadad3211cafa7a87cfa6b554eff8fcb255ec8b813042c31a4898c7f44d
+  data.tar.gz: 55e5001d04db602e98f39b8e4ae23f108917a18a719d93538983620a9423782faba0c26f977fee9dc30ad098072f5a4cf163c8e56bd1ac6bf97d6b8f8bedc78f

data/LICENSE

@@ -0,0 +1,31 @@
+to_be.Ruby - BSD 3-Clause License
+
+Copyright (c) 2025, Matthew Wilson and Synesis Information Systems
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,127 @@
+# to_be.Ruby <!-- omit in toc -->
+
+Simple Ruby library determining whether strings indicate truey or falsy values.
+
+[![Gem Version](https://badge.fury.io/rb/to_be.svg)](https://badge.fury.io/rb/to_be)
+
+
+## Introduction
+
+**to-be** is a library providing facilities for determine whether the truthyness of strings. It implemented in several languages: **to_be.Rust** is the **Ruby** implementation.
+
+
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Terminology](#terminology)
+- [Installation](#installation)
+- [Project Information](#project-information)
+	- [Where to get help](#where-to-get-help)
+	- [Contribution guidelines](#contribution-guidelines)
+	- [Related projects](#related-projects)
+	- [License](#license)
+
+
+## Terminology
+
+The term "*truthy*" is an unhelpfully overloaded term in the programming world, insofar as it is used to refer to the notion of "truthyness" - whether something can be _deemed to be_ interpretable as truth - and also the true side of that interpretation. In this library, the former interpretation is used, leaving us with the following terms:
+
+* "*truthy*" - whether something can be can be _deemed to be_ interpretable as having truth;
+* "*falsey*" - whether an object can be _deemed to be_ interpretable as being false;
+* "*truey*" - whether an object can be _deemed to be_ interpretable as being true;
+
+For example, consider the following **Ruby** program:
+
+```Ruby
+require 'to_be'
+
+s1 = "no"
+s2 = "True"
+s3 = "orange"
+
+# "no" is validly truthy, and is falsey
+ToBe.string_falsey?(s1) # => true
+ToBe.string_truey?(s1) # => false
+ToBe.string_truthy?(s1) # => true
+
+# "True" is validly truthy, and is truey
+ToBe.string_falsey?(s2) # => false
+ToBe.string_truey?(s2) # => true
+ToBe.string_truthy?(s2) # => true
+
+# "orange" is not validly truthy, and is neither falsey nor truey
+ToBe.string_falsey?(s3) # => false
+ToBe.string_truey?(s3) # => false
+ToBe.string_truthy?(s3) # => false
+```
+
+and, if extensions are used, the following **Ruby** program:
+
+```Ruby
+require 'to_be/extensions/string'
+
+s1 = "no"
+s2 = "True"
+s3 = "orange"
+
+# "no" is validly truthy, and is falsey
+s1.falsey? # => true
+s1.truey? # => false
+s1.truthy? # => true
+
+# "True" is validly truthy, and is truey
+s2.falsey? # => false
+s2.truey? # => true
+s2.truthy? # => true
+
+# "orange" is not validly truthy, and is neither falsey nor truey
+s3.falsey? # => false
+s3.truey? # => false
+s3.truthy? # => false
+```
+
+
+## Installation
+
+Install via **gem** as in:
+
+```
+    gem install to_be
+```
+
+or add it to your `Gemfile`.
+
+Use via **require**, as in:
+
+```Ruby
+require 'to_be'
+```
+
+
+## Project Information
+
+
+### Where to get help
+
+[GitHub Page](https://github.com/synesissoftware/to_be.Ruby "GitHub Page")
+
+
+### Contribution guidelines
+
+Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/to_be.Ruby.
+
+
+### Related projects
+
+* [**to-be**](https://github.com/synesissoftware/to-be) (**C**);
+* [**py2be**](https://github.com/synesissoftware/py2be) (**Python**);
+* [**to-be.Rust**](https://github.com/synesissoftware/to-be.Rust);
+
+
+### License
+
+**to_be.Ruby** is released under the 3-clause BSD license. See LICENSE for details.
+
+
+<!-- ########################### end of file ########################### -->
+

data/lib/to_be/extensions/string.rb

@@ -0,0 +1,34 @@
+
+
+require 'to_be/truthy'
+
+class String
+
+  # Indicates that the instance, when trimmed, is classified as "truthy" and
+  # is deemed as "falsey".
+  #
+  # See ToBe::string_falsey?
+  def falsey?
+
+    return ToBe::string_falsey? self
+  end
+
+  # Indicates that the instance, when trimmed, is classified as "truthy" and
+  # is deemed as "falsey".
+  #
+  # See ToBe::string_truey?
+  def truey?
+
+    return ToBe::string_truey? self
+  end
+
+  # Indicates that the instances, when trimmed, is classified as "truthy"
+  # (and is deemed as either "falsey" or "truey").
+  #
+  # See ToBe::string_truthy?
+  def truthy?
+
+    return ToBe::string_truthy? self
+  end
+end # class String
+

data/lib/to_be/internal/_str2bool.rb

@@ -0,0 +1,73 @@
+
+=begin
+=end
+
+module ToBe
+module Internal
+
+  module Constants_
+
+    FALSEY_PRECISE_STRINGS = [
+      "0",
+      "FALSE",
+      "False",
+      "NO",
+      "No",
+      "OFF",
+      "Off",
+      "false",
+      "no",
+      "off",
+    ]
+
+    TRUEY_PRECISE_STRINGS = [
+      "1",
+      "ON",
+      "On",
+      "TRUE",
+      "True",
+      "YES",
+      "Yes",
+      "on",
+      "true",
+      "yes",
+    ]
+
+    FALSEY_LOWERCASE_STRINGS = [
+      "false",
+      "no",
+      "off",
+      "0",
+    ]
+
+    TRUEY_LOWERCASE_STRINGS = [
+      "true",
+      "yes",
+      "on",
+      "1",
+    ]
+
+  end # module Constants_
+
+  def self._str2bool s
+
+    return nil if s.nil?
+
+    return true if Constants_::TRUEY_PRECISE_STRINGS.include? s
+
+    return false if Constants_::FALSEY_PRECISE_STRINGS.include? s
+
+    s = s.strip.downcase
+
+    return true if Constants_::TRUEY_LOWERCASE_STRINGS.include? s
+
+    return false if Constants_::FALSEY_LOWERCASE_STRINGS.include? s
+
+    nil
+  end
+end # module Internal
+end # module ToBe
+
+
+# ############################## end of file ############################# #
+

data/lib/to_be/truthy.rb

@@ -0,0 +1,48 @@
+
+
+require 'to_be/internal/_str2bool'
+
+=begin
+=end
+
+module ToBe
+
+  # Determines the "truthy" nature of whether the given string is "truthy"
+  # and, if so, whether it is "falsey" or "truey".
+  #
+  # Returns:
+  # - `None` - string is not classified as "truthy";
+  # - `False` - string is classified as "truthy" and is deemed "falsey";
+  # - `True` - string is classified as "truthy" and is deemed "truey";
+  def str2bool s
+
+    ToBe::Internal::_str2bool s
+  end
+
+  # Indicates that the given string, when trimmed, is classified as "truthy"
+  # and is deemed as "falsey".
+  def string_falsey? s
+
+    return false == ToBe::Internal::_str2bool(s)
+  end
+
+  # Indicates that the given string, when trimmed, is classified as "truthy"
+  # and is deemed as "truey".
+  def string_truey? s
+
+    return true == ToBe::Internal::_str2bool(s)
+  end
+
+  # Indicates that the given string, when trimmed, is classified as "truthy"
+  # (and is deemed as either "falsey" or "truey").
+  def string_truthy? s
+
+    return !ToBe::Internal::_str2bool(s).nil?
+  end
+
+  module_function :string_falsey?, :string_truey?, :string_truthy?
+end # module ToBe
+
+
+# ############################## end of file ############################# #
+

data/lib/to_be/version.rb

@@ -0,0 +1,70 @@
+
+# ######################################################################## #
+# File:     to_be/version.rb
+#
+# Purpose:  Version for ToBe.Ruby library
+#
+# Created:  11th August 2025
+# Updated:  11th August 2025
+#
+# Home:     http://github.com/synesissoftware/to_be.Ruby
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 2025, Matthew Wilson and Synesis Information Systems
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+
+=begin
+=end
+
+module ToBe
+
+  # Current version of the ToBe.Ruby library
+  VERSION           = '0.0.1'
+
+  private
+  # @!visibility private
+  VERSION_PARTS_    = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+  public
+  # Major version of the ToBe.Ruby library
+  VERSION_MAJOR     = VERSION_PARTS_[0] # :nodoc:
+  # Minor version of the ToBe.Ruby library
+  VERSION_MINOR     = VERSION_PARTS_[1] # :nodoc:
+  # Revision version of the ToBe.Ruby library
+  VERSION_REVISION  = VERSION_PARTS_[2] # :nodoc:
+end # module ToBe
+
+
+# ############################## end of file ############################# #
+

data/lib/to_be.rb

@@ -0,0 +1,12 @@
+
+
+=begin
+=end
+
+module ToBe
+
+end # module ToBe
+
+require 'to_be/truthy'
+require 'to_be/version'
+

data/test/unit/tc_extensions_truthy.rb

@@ -0,0 +1,97 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'to_be/extensions/string'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+
+class Test_ToBe_EXTENSIONS_String < Test::Unit::TestCase
+
+  def test__string_falsey?()
+
+    assert_false "".falsey?
+    assert_false "Copyright ©".falsey?
+
+    assert_true "0".falsey?
+    assert_true "false".falsey?
+    assert_true " FALSE".falsey?
+    assert_true "False".falsey?
+    assert_true "FaLSe".falsey?
+    assert_true "no".falsey?
+    assert_true "No ".falsey?
+    assert_true "NO".falsey?
+    assert_true " Off ".falsey?
+    assert_true "off".falsey?
+    assert_true "OFF".falsey?
+
+    assert_false "1".falsey?
+    assert_false "true".falsey?
+    assert_false "TRUE".falsey?
+    assert_false "True".falsey?
+    assert_false "tRuE".falsey?
+    assert_false "yes".falsey?
+    assert_false " YES".falsey?
+    assert_false "Yes   ".falsey?
+    assert_false "yEs".falsey?
+  end
+
+  def test__string_truey?()
+
+    assert_false "".truey?
+    assert_false "Copyright ©".truey?
+
+    assert_false "0".truey?
+    assert_false "false".truey?
+    assert_false " FALSE".truey?
+    assert_false "False".truey?
+    assert_false "FaLSe".truey?
+    assert_false "no".truey?
+    assert_false "No ".truey?
+    assert_false "NO".truey?
+    assert_false " Off ".truey?
+    assert_false "off".truey?
+    assert_false "OFF".truey?
+
+    assert_true "1".truey?
+    assert_true "true".truey?
+    assert_true "TRUE".truey?
+    assert_true "True".truey?
+    assert_true "tRuE".truey?
+    assert_true "yes".truey?
+    assert_true " YES".truey?
+    assert_true "Yes   ".truey?
+    assert_true "yEs".truey?
+  end
+
+  def test__string_truthy?()
+
+    assert_false "".truthy?
+    assert_false "Copyright ©".truthy?
+
+    assert_true "0".truthy?
+    assert_true "false".truthy?
+    assert_true " FALSE".truthy?
+    assert_true "False".truthy?
+    assert_true "FaLSe".truthy?
+    assert_true "no".truthy?
+    assert_true "No ".truthy?
+    assert_true "NO".truthy?
+    assert_true " Off ".truthy?
+    assert_true "off".truthy?
+    assert_true "OFF".truthy?
+
+    assert_true "1".truthy?
+    assert_true "true".truthy?
+    assert_true "TRUE".truthy?
+    assert_true "True".truthy?
+    assert_true "tRuE".truthy?
+    assert_true "yes".truthy?
+    assert_true " YES".truthy?
+    assert_true "Yes   ".truthy?
+    assert_true "yEs".truthy?
+  end
+end
+

data/test/unit/tc_truthy.rb

@@ -0,0 +1,97 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../..', 'lib')
+
+require 'to_be'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+
+class Test_ToBe < Test::Unit::TestCase
+
+  def test__string_falsey?()
+
+    assert_false ToBe.string_falsey?("")
+    assert_false ToBe.string_falsey?("Copyright ©")
+
+    assert_true ToBe.string_falsey?("0")
+    assert_true ToBe.string_falsey?("false")
+    assert_true ToBe.string_falsey?(" FALSE")
+    assert_true ToBe.string_falsey?("False")
+    assert_true ToBe.string_falsey?("FaLSe")
+    assert_true ToBe.string_falsey?("no")
+    assert_true ToBe.string_falsey?("No ")
+    assert_true ToBe.string_falsey?("NO")
+    assert_true ToBe.string_falsey?(" Off ")
+    assert_true ToBe.string_falsey?("off")
+    assert_true ToBe.string_falsey?("OFF")
+
+    assert_false ToBe.string_falsey?("1")
+    assert_false ToBe.string_falsey?("true")
+    assert_false ToBe.string_falsey?("TRUE")
+    assert_false ToBe.string_falsey?("True")
+    assert_false ToBe.string_falsey?("tRuE")
+    assert_false ToBe.string_falsey?("yes")
+    assert_false ToBe.string_falsey?(" YES")
+    assert_false ToBe.string_falsey?("Yes   ")
+    assert_false ToBe.string_falsey?("yEs")
+  end
+
+  def test__string_truey?()
+
+    assert_false ToBe.string_truey?("")
+    assert_false ToBe.string_truey?("Copyright ©")
+
+    assert_false ToBe.string_truey?("0")
+    assert_false ToBe.string_truey?("false")
+    assert_false ToBe.string_truey?(" FALSE")
+    assert_false ToBe.string_truey?("False")
+    assert_false ToBe.string_truey?("FaLSe")
+    assert_false ToBe.string_truey?("no")
+    assert_false ToBe.string_truey?("No ")
+    assert_false ToBe.string_truey?("NO")
+    assert_false ToBe.string_truey?(" Off ")
+    assert_false ToBe.string_truey?("off")
+    assert_false ToBe.string_truey?("OFF")
+
+    assert_true ToBe.string_truey?("1")
+    assert_true ToBe.string_truey?("true")
+    assert_true ToBe.string_truey?("TRUE")
+    assert_true ToBe.string_truey?("True")
+    assert_true ToBe.string_truey?("tRuE")
+    assert_true ToBe.string_truey?("yes")
+    assert_true ToBe.string_truey?(" YES")
+    assert_true ToBe.string_truey?("Yes   ")
+    assert_true ToBe.string_truey?("yEs")
+  end
+
+  def test__string_truthy?()
+
+    assert_false ToBe.string_truthy?("")
+    assert_false ToBe.string_truthy?("Copyright ©")
+
+    assert_true ToBe.string_truthy?("0")
+    assert_true ToBe.string_truthy?("false")
+    assert_true ToBe.string_truthy?(" FALSE")
+    assert_true ToBe.string_truthy?("False")
+    assert_true ToBe.string_truthy?("FaLSe")
+    assert_true ToBe.string_truthy?("no")
+    assert_true ToBe.string_truthy?("No ")
+    assert_true ToBe.string_truthy?("NO")
+    assert_true ToBe.string_truthy?(" Off ")
+    assert_true ToBe.string_truthy?("off")
+    assert_true ToBe.string_truthy?("OFF")
+
+    assert_true ToBe.string_truthy?("1")
+    assert_true ToBe.string_truthy?("true")
+    assert_true ToBe.string_truthy?("TRUE")
+    assert_true ToBe.string_truthy?("True")
+    assert_true ToBe.string_truthy?("tRuE")
+    assert_true ToBe.string_truthy?("yes")
+    assert_true ToBe.string_truthy?(" YES")
+    assert_true ToBe.string_truthy?("Yes   ")
+    assert_true ToBe.string_truthy?("yEs")
+  end
+end
+

data/test/unit/tc_version.rb

@@ -0,0 +1,38 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../lib')
+
+
+require 'to_be/version'
+
+require 'test/unit'
+
+
+class Test_version < Test::Unit::TestCase
+
+  def test_has_VERSION
+
+    assert defined? ToBe::VERSION
+  end
+
+  def test_has_VERSION_MAJOR
+
+    assert defined? ToBe::VERSION_MAJOR
+  end
+
+  def test_has_VERSION_MINOR
+
+    assert defined? ToBe::VERSION_MINOR
+  end
+
+  def test_has_VERSION_REVISION
+
+    assert defined? ToBe::VERSION_REVISION
+  end
+
+  def test_VERSION_has_consistent_format
+
+    assert_equal ToBe::VERSION.split('.')[0..2].join('.'), "#{ToBe::VERSION_MAJOR}.#{ToBe::VERSION_MINOR}.#{ToBe::VERSION_REVISION}"
+  end
+end
+

data/test/unit/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: to_be
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+description: 'Simple Ruby library determining whether strings indicate truey or falsy
+  values.
+
+'
+email: matthew@synesis.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/to_be.rb
+- lib/to_be/extensions/string.rb
+- lib/to_be/internal/_str2bool.rb
+- lib/to_be/truthy.rb
+- lib/to_be/version.rb
+- test/unit/tc_extensions_truthy.rb
+- test/unit/tc_truthy.rb
+- test/unit/tc_version.rb
+- test/unit/ts_all.rb
+homepage: http://github.com/synesissoftware/to_be.Ruby
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.3
+signing_key: 
+specification_version: 4
+summary: to_be
+test_files: []