coerce_boolean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8da60cf8f52ba469738480fdfb160662c9bf27cd99f4178a61aac8dc1b5a42f
+  data.tar.gz: 4e71864cb936bd988d9a7f868e9637f6b83c84f8218f0278355659ec7673bac6
+SHA512:
+  metadata.gz: c22c299e4a4ec8d71e3a52fbfca1f919c29e3cf4367ad48da566048036a1a32dceaebe66655ce4d1f09197b81d99bb5b2fc96c1c2bdc192ccfbde330cf40a221
+  data.tar.gz: 96afa8accfadd124a56e23bbd3e899a8426057868a374fc0dce1e0b2b9cfeef6565e0c517be91d821da56dd9e7541c07fa27e80cd0fa28eb8551ed4c67157250

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Sampson Crowley
+
+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,68 @@
+# CoerceBoolean
+Coerce boolean-like values into their correct values.
+Values to use are inspired by ActiveModel::Type::Boolean
+
+## Coercion
+Coercion behavior is uses Ruby's boolean semantics with additional parsing.
+
+- `nil` and empty strings are coerced to `nil`
+- Any value in `CoerceBoolean::FALSE_VALUES` will be coerced to false
+- All other values will be coerced to `true`
+  - This includes `0` as a `Float` or `BigDecimal`; only `Integer` `0` is false
+
+If the object passed to `.from` responds to `to_boolean`, coercion will be run
+against the result of `to_boolean`
+
+## Strict Mode
+Strict Mode always returns a boolean
+
+- `nil` and empty strings are coerced to `false`
+- All other values follow the coercion rules above
+
+## `to_bool`
+This library adds `to_bool` to the `Object` class to allow users to create
+explicit and implicit conversions in the same manner as `to_s` and `to_str`
+
+- There is both a class method (`.to_bool(...)`) and an instance method
+(`#to_bool(strict: false)`)
+- `.to_bool` will always directly return true unless overridden
+- `#to_bool` will call `CoerceBoolean.from` with `self` and `strict` as args
+
+
+## Examples
+- `CoerceBoolean.from("false") # false`
+- `CoerceBoolean.from("true") # true`
+- `CoerceBoolean.from(1) # true`
+- `CoerceBoolean.from(0) # false`
+- `CoerceBoolean.from("") # nil`
+- `CoerceBoolean.from(nil) # nil`
+- `CoerceBoolean.from(nil, strict: true) # false`
+- `SomeClass.to_bool # true`
+- `"".to_bool # nil`
+- `"".to_bool(strict: true) # false`
+- `0.to_bool # false`
+- `0.0.to_bool # true`
+- `0.1.to_bool # true`
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'coerce_boolean'
+```
+And then execute:
+```bash
+$ bundle
+```
+
+Or add and install directly with bundler:
+```ruby
+bundle add 'coerce_boolean'
+```
+
+Or install it directly with:
+```bash
+$ gem install coerce_boolean
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/coerce_boolean.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative './object'
+
+class CoerceBoolean
+  FALSE_VALUES = Set[
+    false, 0,
+    "0", :"0",
+    "f", :f,
+    "F", :F,
+    "false", :false,
+    "FALSE", :FALSE,
+    "off", :off,
+    "OFF", :OFF,
+  ].freeze
+
+  class << self
+    def from(value, strict: false)
+      value = value.to_boolean if value.respond_to? :to_boolean
+
+      strict ? !!coerce(value) : coerce(value)
+    end
+
+    private
+      def empty?(value)
+        value.nil? || (value == "")
+      end
+
+      def coerce(value)
+        if empty?(value)
+          nil
+        else
+          !FALSE_VALUES.include?(value)
+        end
+      end
+  end
+end

data/lib/coerce_boolean/version.rb

@@ -0,0 +1,3 @@
+class CoerceBoolean
+  VERSION = '0.1.0'
+end

data/lib/object.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Object
+  # == Constants ============================================================
+
+  # == Attributes ===========================================================
+
+  # == Extensions ===========================================================
+
+  # == Boolean Class Methods ================================================
+
+  # == Class Methods ========================================================
+  def self.to_bool(...)
+    true
+  end
+
+  # == Boolean Methods ======================================================
+
+  # == Instance Methods =====================================================
+  def to_bool(strict: false)
+    CoerceBoolean.from(self, strict: strict)
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: coerce_boolean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sampson Crowley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: |2
+      Adds a default #to_bool method to Object and adds
+      the CoerceBoolean class to parse boolean like values
+
+      Examples:
+        - CoerceBoolean.from("false") # false
+        - CoerceBoolean.from("true") # true
+        - CoerceBoolean.from(1) # true
+        - CoerceBoolean.from(0) # false
+email:
+- sampsonsprojects@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/coerce_boolean.rb
+- lib/coerce_boolean/version.rb
+- lib/object.rb
+homepage: https://github.com/SampsonCrowley/coerce_boolean
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ActiveRecord style Boolean cooersion
+test_files: []