wannabe_bool 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8be47f9bd1c7e8f4c39b6186fe6f6fe8c4c5c638
-  data.tar.gz: 466811c19ea0b1d2d5b069c5f362ef703956c096
+  metadata.gz: 9e7cd3d1239a38da5d61de3c93b3fc69a5360780
+  data.tar.gz: d04b86b2681366494b5d43a6e9b7ee6b5c9d3d5c
 SHA512:
-  metadata.gz: 98a600076e2b33f70f863d9a1b62d29ac9fbcaa9e393bc9a06c580954b43593183617b142297e07a7c652a142f15a4fcb8b389b72d73c306fc9b9fe8366c2f3a
-  data.tar.gz: 7098d24507ce3eb02f0ea3854c984584659852cf0fd13907cc25faa69aad8f4828c09c2a65a1c83168bde57077121a308a183b648fe776b85bcc2efb20b6f490
+  metadata.gz: 04e2b48c0164dba042a5045281f8341266ca1ff6fec0bad05f8ab3ab950c6c5eca7eec263f9b2d3592020b65fc623a60c9679f6b81c22ad2a646516abd4e4566
+  data.tar.gz: 16bbfc7517b8f63ff091a80473d0f97e2919fd266beb0499f90bd63394473067f38875b196518d6fdb727278ebbc97e725b46a8e635f13d925e9990c1b5427bc

data/.travis.yml

@@ -1,14 +1,28 @@
 language: ruby
+
 rvm:
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+  - jruby-9
+  - jruby
   - jruby-19mode
   - jruby-head
   - rbx
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: rbx
+    - rvm: rbx-2
+  fast_finish: true
+
 script: bundle exec rspec
 cache: bundler
 sudo: false

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 | Version | Changes |
 | ------- | ------- |
+| 0.6.0   | Invalid value behaviours. [Issue #5](https://github.com/prodis/wannabe_bool/issues/5). |
 | 0.5.0   | No Ruby version required. |
 | 0.4.0   | `to_b` in `Numeric` class, not only in `Integer` class. |
 | 0.3.0   | Fix integer to boolean conversion. [Issue #2](https://github.com/prodis/wannabe_bool/issues/2) |

data/CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing to wannabe_bool
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Don't forget to rebase with branch master in main project before submit the pull request.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 Fernando Hamasaki de Amorim
+Copyright (c) 2014-2016 Fernando Hamasaki de Amorim
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -32,84 +32,103 @@ require 'wannabe_bool'
 ```
 
 #### String
-Returns `true` if string is one of **t**, **true**, **on**, **y**, **yes** or **1** values. Returns `false` otherwise.
+* Returns `true` if string is one of these values: **t**, **true**, **on**, **y**, **yes**, **1**.
+* Returns `false` if string is one of these values: **f**, **false**, **off**, **n**, **no**, **0**.
+* For invalid boolean string representations, returns `false` by default. See "Invalid Value Behaviour" section for more options.
 
-Ignores trailing spaces and letter cases.
+It ignores trailing spaces and letter cases.
 
 ```ruby
-'1'.to_b        # => true
-'t'.to_b        # => true
-'T'.to_b        # => true
-'true'.to_b     # => true
-'TRUE'.to_b     # => true
-'on'.to_b       # => true
-'ON'.to_b       # => true
-'y'.to_b        # => true
-'yes'.to_b      # => true
-'YES'.to_b      # => true
-
-' 1 '.to_b      # => true
-' t '.to_b      # => true
-' T '.to_b      # => true
-' true '.to_b   # => true
-' TRUE '.to_b   # => true
-' on '.to_b     # => true
-' ON '.to_b     # => true
-' y '.to_b      # => true
-'Y'.to_b        # => true
-' Y '.to_b      # => true
-' yes '.to_b    # => true
-' YES '.to_b    # => true
-
-''.to_b         # => false
-'0'.to_b        # => false
-'2'.to_b        # => false
-'-1'.to_b       # => false
-'-2'.to_b       # => false
-'f'.to_b        # => false
-'F'.to_b        # => false
-'false'.to_b    # => false
-'FALSE'.to_b    # => false
-'off'.to_b      # => false
-'OFF'.to_b      # => false
-'n'.to_b        # => false
-'N'.to_b        # => false
-'no'.to_b       # => false
-'NO'.to_b       # => false
-'not'.to_b      # => false
-'NOT'.to_b      # => false
+'1'.to_b    # => true
+'t'.to_b    # => true
+'T'.to_b    # => true
+'true'.to_b # => true
+'TRUE'.to_b # => true
+'on'.to_b   # => true
+'ON'.to_b   # => true
+'y'.to_b    # => true
+'yes'.to_b  # => true
+'YES'.to_b  # => true
+
+' 1 '.to_b    # => true
+' t '.to_b    # => true
+' T '.to_b    # => true
+' true '.to_b # => true
+' TRUE '.to_b # => true
+' on '.to_b   # => true
+' ON '.to_b   # => true
+' y '.to_b    # => true
+'Y'.to_b      # => true
+' Y '.to_b    # => true
+' yes '.to_b  # => true
+' YES '.to_b  # => true
+
+'0'.to_b     # => false
+'f'.to_b     # => false
+'F'.to_b     # => false
+'false'.to_b # => false
+'FALSE'.to_b # => false
+'off'.to_b   # => false
+'OFF'.to_b   # => false
+'n'.to_b     # => false
+'N'.to_b     # => false
+'no'.to_b    # => false
+'NO'.to_b    # => false
+
+' 0 '.to_b     # => false
+' f '.to_b     # => false
+' F '.to_b     # => false
+' false '.to_b # => false
+' FALSE '.to_b # => false
+' off '.to_b   # => false
+' OFF '.to_b   # => false
+' n '.to_b     # => false
+' N '.to_b     # => false
+' no '.to_b    # => false
+' NO '.to_b    # => false
+```
+##### Invalid Value Behaviour
+You can configure the result for invalid boolean string representations, using the `WannabeBool.invalid_value_behaviour` option.
+
+There are 3 predefined behaviours available: to return `false` (default), `nil` or raise an `ArgumentError`:
+
+```ruby
+# WannabeBool.invalid_value_behaviour = WannabeBool::InvalidValueBehaviour::False
 'wherever'.to_b # => false
+
+WannabeBool.invalid_value_behaviour = WannabeBool::InvalidValueBehaviour::Nil
+'wherever'.to_b # => nil
+
+WannabeBool.invalid_value_behaviour = WannabeBool::InvalidValueBehaviour::Error
+'wherever'.to_b # => ArgumentError: is not a valid boolean representation
 ```
 
+Moreover you can provide your own behaviour for invalid boolean string representations. Just set a proc or lambda, or even any class or object that responds to `call` method.
+
+```ruby
+WannabeBool.invalid_value_behaviour = -> { :prodis }
+'wherever'.to_b # => :prodis
+```
+
+Note that `WannabeBool.invalid_value_behaviour` is a global configuration, so all results for `to_b` method with invalid boolean string representations will be affected.
+
 #### Symbol
 Same as `symbol.to_s.to_b`.
 
 ```ruby
-:'1'.to_b      # => true
-:t.to_b        # => true
-:T.to_b        # => true
-:true.to_b     # => true
-:TRUE.to_b     # => true
-:on.to_b       # => true
-:ON.to_b       # => true
-:y.to_b        # => true
-:Y.to_b        # => true
-:yes.to_b      # => true
-:YES.to_b      # => true
-
-:f.to_b        # => false
-:F.to_b        # => false
-:false.to_b    # => false
-:FALSE.to_b    # => false
-:off.to_b      # => false
-:OFF.to_b      # => false
-:n.to_b        # => false
-:N.to_b        # => false
-:no.to_b       # => false
-:NO.to_b       # => false
-:not.to_b      # => false
-:NOT.to_b      # => false
-:wherever.to_b # => false
+:'1'.to_b  # => true
+:t.to_b    # => true
+:true.to_b # => true
+:on.to_b   # => true
+:y.to_b    # => true
+:yes.to_b  # => true
+
+:'0'.to_b   # => false
+:f.to_b     # => false
+:false.to_b # => false
+:off.to_b   # => false
+:n.to_b     # => false
+:no.to_b    # => false
 ```
 
 #### Numeric
@@ -165,7 +184,7 @@ Returns `false`.
 nil.to_b # => false
 ```
 
-#### Creating predicate methods
+### Creating predicate methods
 
 ```ruby
 class Fake
@@ -201,15 +220,7 @@ fake.published? # => true
 
 ![Prodis Logo](http://prodis.net.br/images/prodis_150.gif)
 
+## Contributing to wannabe_bool
 
-## Contributing to **wannabe_bool**
-
-- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-- Fork the project.
-- Start a feature/bugfix branch.
-- Commit and push until you are happy with your contribution.
-- Don't forget to rebase with branch master in main project before submit the pull request.
-- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+[See the contributing guide.](CONTRIBUTING.md)
 

data/lib/wannabe_bool.rb

@@ -1,5 +1,7 @@
 module WannabeBool; end
 
+require 'wannabe_bool/invalid_value_behaviour'
+require 'wannabe_bool/configuration'
 require 'wannabe_bool/boolean'
 require 'wannabe_bool/nil'
 require 'wannabe_bool/numeric'

data/lib/wannabe_bool/configuration.rb

@@ -0,0 +1,15 @@
+module WannabeBool::Configuration
+  def invalid_value_behaviour=(behaviour)
+    raise ArgumentError, 'behaviour does not respond to call method' unless behaviour.respond_to?(:call)
+
+    @invalid_value_behaviour = behaviour
+  end
+
+  def invalid_value_behaviour
+    @invalid_value_behaviour ||= WannabeBool::InvalidValueBehaviour::False
+  end
+end
+
+module WannabeBool
+  extend WannabeBool::Configuration
+end

data/lib/wannabe_bool/invalid_value_behaviour.rb

@@ -0,0 +1,19 @@
+module WannabeBool::InvalidValueBehaviour
+  module False
+    def self.call
+      false
+    end
+  end
+
+  module Nil
+    def self.call
+      nil
+    end
+  end
+
+  module Error
+    def self.call
+      raise ArgumentError, 'is not a valid boolean representation'
+    end
+  end
+end

data/lib/wannabe_bool/string.rb

@@ -1,8 +1,13 @@
 module WannabeBool::String
-  TRUES = %W{t true on y yes 1}.freeze
+  TRUES  = %W{t true on y yes 1}.freeze
+  FALSES = %W{f false off n no 0}.freeze
 
   def to_b
-    TRUES.include?(self.strip.downcase)
+    value = self.strip.downcase
+    return true  if TRUES.include?(value)
+    return false if FALSES.include?(value)
+
+    WannabeBool.invalid_value_behaviour.call
   end
 end
 

data/lib/wannabe_bool/version.rb

@@ -1,3 +1,3 @@
 module WannabeBool
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/spec_helper.rb

@@ -3,9 +3,23 @@ require 'wannabe_bool'
 
 Coveralls.wear!
 
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = 'random'
+  config.order = :random
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  Kernel.srand config.seed
 end

data/spec/wannabe_bool/attributes_spec.rb

@@ -15,7 +15,7 @@ class Fake
   end
 end
 
-describe WannabeBool::Attributes do
+RSpec.describe WannabeBool::Attributes do
   context 'when reader attribute exists' do
     let(:subject_methods) do
       fake = Fake.new(true, true)

data/spec/wannabe_bool/boolean_spec.rb

@@ -1,4 +1,4 @@
-describe WannabeBool::Boolean do
+RSpec.describe WannabeBool::Boolean do
   context TrueClass do
     subject { true }
 

data/spec/wannabe_bool/invalid_value_behaviour_spec.rb

@@ -0,0 +1,22 @@
+RSpec.describe WannabeBool::InvalidValueBehaviour do
+  context 'False' do
+    describe '#call' do
+      subject { WannabeBool::InvalidValueBehaviour::False.call }
+      it { is_expected.to be false }
+    end
+  end
+
+  context 'Nil' do
+    describe '#call' do
+      subject { WannabeBool::InvalidValueBehaviour::Nil.call }
+      it { is_expected.to be nil }
+    end
+  end
+
+  context 'Error' do
+    describe '#call' do
+      subject { WannabeBool::InvalidValueBehaviour::Error.call }
+      it { expect { subject }.to raise_error(ArgumentError, 'is not a valid boolean representation') }
+    end
+  end
+end

data/spec/wannabe_bool/nil_spec.rb

@@ -1,4 +1,4 @@
-describe WannabeBool::Nil do
+RSpec.describe WannabeBool::Nil do
   context NilClass do
     subject { nil }
 

data/spec/wannabe_bool/numeric_spec.rb

@@ -1,6 +1,6 @@
 require 'bigdecimal'
 
-describe WannabeBool::Numeric do
+RSpec.describe WannabeBool::Numeric do
   context Integer do
     describe '#to_b' do
       context 'when value is 0' do

data/spec/wannabe_bool/string_spec.rb

@@ -1,39 +1,66 @@
-describe WannabeBool::String do
+RSpec.describe WannabeBool::String do
   describe '#to_b' do
-    [ '1', '1 ', ' 1', ' 1 ',
-      't', 't ', ' t', ' t ',
-      'T', 'T ', ' T', ' T ',
-      'true', 'true ', ' true', ' true ',
-      'TRUE', 'TRUE ', ' TRUE', ' TRUE ',
-      'on', 'on ', ' on', ' on ',
-      'ON', 'ON ', ' ON ', ' ON ',
-      'y', 'y ', ' y', ' y ',
-      'Y', 'Y ', ' Y', ' Y ',
-      'yes', 'yes ', ' yes', ' yes ',
-      'YES', 'YES ', ' YES', ' YES '
-    ].each do |value|
-      context "when string is '#{value}'" do
-        subject { value }
-        it { expect(subject.to_b).to be true }
+    context 'truthy values' do
+      [ '1', '1 ', ' 1', ' 1 ',
+        't', 't ', ' t', ' t ',
+        'T', 'T ', ' T', ' T ',
+        'true', 'true ', ' true', ' true ',
+        'TRUE', 'TRUE ', ' TRUE', ' TRUE ',
+        'on', 'on ', ' on', ' on ',
+        'ON', 'ON ', ' ON ', ' ON ',
+        'y', 'y ', ' y', ' y ',
+        'Y', 'Y ', ' Y', ' Y ',
+        'yes', 'yes ', ' yes', ' yes ',
+        'YES', 'YES ', ' YES', ' YES '
+      ].each do |value|
+        context "when string is '#{value}'" do
+          subject { value.to_b }
+          it { is_expected.to be true }
+        end
       end
     end
 
-    [ '',
-      '0',
-      '2', '2 ', ' 2', ' 2 ',
-     '-1', '-1 ', ' -1', ' -1 ',
-     '-2', '-2 ', ' -2', ' -2 ',
-      'f', 'F',
-      'false', 'FALSE',
-      'off', 'OFF',
-      'n', 'N',
-      'no', 'NO',
-      'not', 'NOT',
-      'wherever', 'Prodis'
-    ].each do |value|
-      context "when string is '#{value}'" do
-        subject { value }
-        it { expect(subject.to_b).to be false }
+    context 'falsey values' do
+      [ '0', '0 ', ' 0', ' 0 ',
+        'f', 'f ', ' f', ' f ',
+        'F', 'F ', ' F', ' F ',
+        'false', 'false ', ' false', ' false ',
+        'FALSE', 'FALSE ', ' FALSE', ' FALSE ',
+        'off', 'off ', ' off', ' off ',
+        'OFF', 'OFF ', ' OFF ', ' OFF ',
+        'n', 'n ', ' n', ' n ',
+        'N', 'N ', ' N', ' N ',
+        'no', 'no ', ' no', ' no ',
+        'NO', 'NO ', ' NO', ' NO '
+      ].each do |value|
+        context "when string is '#{value}'" do
+          subject { value.to_b }
+          it { is_expected.to be false }
+        end
+      end
+    end
+
+    context 'invalid values' do
+      after do
+        WannabeBool.invalid_value_behaviour = WannabeBool::InvalidValueBehaviour::False
+      end
+
+      context 'when an invalid value behaviour is given' do
+        before do
+          WannabeBool.invalid_value_behaviour = -> { :wherever }
+        end
+
+        [ '', 'nil',
+          '2', '-1', '-2',
+          'not', 'NOT',
+          'wherever', 'Prodis'
+        ].each do |value|
+          context "when string is '#{value}'" do
+            it 'returns the result of the given behaviour' do
+              expect(value.to_b).to be :wherever
+            end
+          end
+        end
       end
     end
   end

data/spec/wannabe_bool/symbol_spec.rb

@@ -1,4 +1,4 @@
-describe WannabeBool::Symbol do
+RSpec.describe WannabeBool::Symbol do
   describe '#to_b' do
     [ :'1', :'1 ', :' 1 ', :' 1',
       :t, :'t ', :' t', :' t ',

data/spec/wannabe_bool_spec.rb

@@ -0,0 +1,39 @@
+RSpec.describe WannabeBool do
+  context 'configuration' do
+    subject { described_class }
+
+    describe '.invalid_value_behaviour' do
+      context 'default behaviour' do
+        it 'is WannabeBool::InvalidValueBehaviour::False' do
+          expect(subject.invalid_value_behaviour).to eq WannabeBool::InvalidValueBehaviour::False
+        end
+      end
+    end
+
+    describe '.invalid_value_behaviour=' do
+      context 'when behaviour responds to call method' do
+        let(:behaviour) do
+          -> { :wherever }
+        end
+
+        before do
+          subject.invalid_value_behaviour = behaviour
+        end
+
+        after do
+          subject.invalid_value_behaviour = WannabeBool::InvalidValueBehaviour::False
+        end
+
+        it "sets the behaviour" do
+          expect(subject.invalid_value_behaviour).to eq behaviour
+        end
+      end
+
+      context 'when behaviour does not respond to call method' do
+        it 'raises argument error' do
+          expect { subject.invalid_value_behaviour = String }.to raise_error(ArgumentError, 'behaviour does not respond to call method')
+        end
+      end
+    end
+  end
+end

data/wannabe_bool.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wannabe_bool
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Prodis a.k.a. Fernando Hamasaki de Amorim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 description: 'If string, numeric, symbol and nil values wanna be a boolean value,
   they can with the new #to_b method (and more).'
 email: prodis@gmail.com
@@ -63,6 +63,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -70,6 +71,8 @@ files:
 - lib/wannabe_bool.rb
 - lib/wannabe_bool/attributes.rb
 - lib/wannabe_bool/boolean.rb
+- lib/wannabe_bool/configuration.rb
+- lib/wannabe_bool/invalid_value_behaviour.rb
 - lib/wannabe_bool/nil.rb
 - lib/wannabe_bool/numeric.rb
 - lib/wannabe_bool/string.rb
@@ -78,10 +81,12 @@ files:
 - spec/spec_helper.rb
 - spec/wannabe_bool/attributes_spec.rb
 - spec/wannabe_bool/boolean_spec.rb
+- spec/wannabe_bool/invalid_value_behaviour_spec.rb
 - spec/wannabe_bool/nil_spec.rb
 - spec/wannabe_bool/numeric_spec.rb
 - spec/wannabe_bool/string_spec.rb
 - spec/wannabe_bool/symbol_spec.rb
+- spec/wannabe_bool_spec.rb
 - wannabe_bool.gemspec
 homepage: https://github.com/prodis/wannabe_bool
 licenses:
@@ -103,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: 'If string, numeric, symbol and nil values wanna be a boolean value, they
@@ -112,7 +117,9 @@ test_files:
 - spec/spec_helper.rb
 - spec/wannabe_bool/attributes_spec.rb
 - spec/wannabe_bool/boolean_spec.rb
+- spec/wannabe_bool/invalid_value_behaviour_spec.rb
 - spec/wannabe_bool/nil_spec.rb
 - spec/wannabe_bool/numeric_spec.rb
 - spec/wannabe_bool/string_spec.rb
 - spec/wannabe_bool/symbol_spec.rb
+- spec/wannabe_bool_spec.rb