booleans 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c61a7f997b836a4c37f276700b566887f42243f5ce3328d61135b0efe1bb4db
+  data.tar.gz: dd31205816c376a2a2b5f75c1ae9b84417ea62fb8570306dfd0d7d70cf0bfc09
+SHA512:
+  metadata.gz: 2174881be8926092026a7c69697d6987aecc536bfec11b7cd8013ed46e19aa0ec17596bcae18a1ea0211c1751bffaa278daf1e8d5eb525ae140647520333cfce
+  data.tar.gz: 1a8941ae0cc3c9c8e2a52b9dc68d1c842b07bf12616f6bd431db3fa8b1e315fe9a75c720808f9be0f7050659db7342e3d0361be701813c3ea2d08cb30ad34f55

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mateusz Drewniak
+
+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,76 @@
+# Booleans
+
+This gem adds a new method called `Boolean`, analogous to builtins like `Integer` or `String`, which converts
+a Ruby value to either `true` or `false` based on its truthiness.
+
+It also has optional core extensions that add a `to_bool` method to all Ruby objects and allow you to check if a value is boolean with `val.is_a?(Boolean)`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add booleans
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install booleans
+
+## Usage
+
+Once you load the gem, you can use the `Boolean` method to convert objects to `true` or `false`.
+
+```rb
+require 'booleans'
+
+Boolean(5)      #=> true
+Boolean(0)      #=> true
+Boolean("foo")  #=> true
+Boolean("")     #=> true
+Boolean([])     #=> true
+Boolean(nil)    #=> false
+Boolean(false)  #=> false
+```
+
+All values except `false` and `nil` get converted to `true`.
+
+### Core extensions
+
+There is also an optional file you can load with core extensions.
+
+This adds a new method `to_bool` to all Ruby objects.
+
+```rb
+require 'booleans/core_extension'
+
+5.to_bool      #=> true
+0.to_bool      #=> true
+"foo".to_bool  #=> true
+"".to_bool     #=> true
+[].to_bool     #=> true
+nil.to_bool    #=> false
+false.to_bool  #=> false
+```
+
+It also includes the `Boolean` module to `TrueClass` and `FalseClass`
+which allows you to check if a value is a boolean like this.
+
+```rb
+true.is_a?(Boolean)     #=> true
+false.is_a?(Boolean)    #=> true
+nil.is_a?(Boolean)      #=> false
+5.is_a?(Boolean)        #=> false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Verseth/ruby-booleans.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/booleans/core_extension.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "../booleans"
+
+module Boolean
+  # Contains additional methods that are added by
+  # the `booleans` gem to `Object`.
+  module CoreExtension
+    # Convert a Ruby value to `true` or `false`
+    # according to the truthiness of the value.
+    #
+    # Most Ruby objects get converted to `true` with the
+    # exception of: `nil` and `false`.
+    def to_bool
+      return true if self
+
+      false
+    end
+  end
+end
+
+Object.include(Boolean::CoreExtension)
+TrueClass.include(Boolean)
+FalseClass.include(Boolean)

data/lib/booleans/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Booleans
+  # @return [String]
+  VERSION = "0.1.0"
+end

data/lib/booleans.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "booleans/version"
+
+# Convert a Ruby value to `true` or `false`
+# according to the truthiness of the value.
+#
+# Most Ruby objects get converted to `true` with the
+# exception of: `nil` and `false`.
+#
+# @return [Boolean]
+def Boolean(val) # rubocop:disable Naming/MethodName
+  return true if val
+
+  false
+end

data/sig/booleans.rbs

@@ -0,0 +1,7 @@
+module Booleans
+  VERSION: String
+
+  def to_bool: () -> bool
+end
+
+def Boolean: (boolish) -> bool

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: booleans
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-20 00:00:00.000000000 Z
+dependencies: []
+description: |
+  This gem adds a new method called `Boolean`, analogous to builtins like `Integer` or `String`, which converts
+  a Ruby value to either `true` or `false` based on its truthiness.
+
+  It also has optional core extensions that add a `to_bool` method to all Ruby objects and allow you to check if a value is boolean with `val.is_a?(Boolean)`.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/booleans.rb
+- lib/booleans/core_extension.rb
+- lib/booleans/version.rb
+- sig/booleans.rbs
+homepage: https://github.com/Verseth/ruby-booleans
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-booleans
+  source_code_uri: https://github.com/Verseth/ruby-booleans
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Convert Ruby values to true or false in a convenient and reliable manner.
+test_files: []