much-boolean 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 19242c1105e248ee22d620f3753f9df082af7a07
-  data.tar.gz: c2da6ded6b3ff22e1c7999e81ad7bebe1c4c9be5
-SHA512:
-  metadata.gz: c5df601f8ee5f18616f19fd2e3257daae376ec8e8d41bfc45066b96cbdedad74ee61a4483c964b4af47f8da933868e5312b301ff1a4108174172d328300b906a
-  data.tar.gz: 3f087f6b1a4bbc1b27a9894d6771a409c0ba0868c33e4e91a5b25f21830d079f2135f67ca5814646a2767df4f0964a8db7a321ca532b61e3594ad757605d4c40
+--- 
+SHA1: 
+  metadata.gz: 48aafb38b7e679d55b28931ecdd3faaecdf9002b
+  data.tar.gz: c4e0ffce78e57e3dc90c99cc057c100ba62cc39a
+SHA512: 
+  metadata.gz: b8327489713a0b0ddece4c7ba41977d780f3050c532d6a7fdc4e9c85a89544797ec2ef0bb62f1255f56ccf1aec62d11ac65e3d8b7aaad6a7f36df53d37dd5db0
+  data.tar.gz: f9fafdee5f32d913d492ff660e6c5c68fbead9788f9055c8cd88ba73717eb53d094e65649fa96dc7b37b02de7b22bcb5bec77aa664fbfe1a839c0c5439789848

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rake', "~> 10.4.0"
 gem 'pry', "~> 0.9.0"

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2015-Present Kelly Redding and Collin Redding
+Copyright (c) 2016-Present Kelly Redding and Collin Redding
 
 MIT License
 

data/README.md

@@ -1,10 +1,80 @@
 # MuchBoolean
 
-TODO: Write a gem description
+An API for friendly boolean conversion, interpretation and handling
 
 ## Usage
 
-TODO: Write code samples and usage instructions here
+```ruby
+require 'much-boolean'
+MuchBoolean::FALSE_VALUES # => [ nil, 0, "0",
+                          #      false, "false", "False", "FALSE", "f", "F",
+                          #      "no", "No", "NO", "n", "N"
+                          #    ]
+
+# nil, zero/one type values
+MuchBoolean.convert(nil) # => false
+MuchBoolean.convert(0)   # => false
+MuchBoolean.convert('0') # => false
+MuchBoolean.convert(1)   # => true
+MuchBoolean.convert('1') # => true
+
+# true/false type values
+MuchBoolean.convert(false)   # => false
+MuchBoolean.convert("false") # => false
+MuchBoolean.convert("False") # => false
+MuchBoolean.convert("FALSE") # => false
+MuchBoolean.convert("f")     # => false
+MuchBoolean.convert("F")     # => false
+MuchBoolean.convert(true)    # => true
+MuchBoolean.convert("true")  # => true
+MuchBoolean.convert("True")  # => true
+MuchBoolean.convert("TRUE")  # => true
+MuchBoolean.convert("t")     # => true
+MuchBoolean.convert("T")     # => true
+
+# yes/no type values
+MuchBoolean.convert("no")  # => false
+MuchBoolean.convert("No")  # => false
+MuchBoolean.convert("NO")  # => false
+MuchBoolean.convert("n")   # => false
+MuchBoolean.convert("N")   # => false
+MuchBoolean.convert("yes") # => true
+MuchBoolean.convert("Yes") # => true
+MuchBoolean.convert("YES") # => true
+MuchBoolean.convert("y")   # => true
+MuchBoolean.convert("Y")   # => true
+
+# all other values always interpreted as `true`
+MuchBoolean.convert('some-string') # => true
+MuchBoolean.convert('1938')        # => true
+MuchBoolean.convert('1938.5')      # => true
+MuchBoolean.convert(Date.today)    # => true
+MuchBoolean.convert(Time.now)      # => true
+
+
+
+# create instances to track given values and the actually boolean values they map to
+
+bool = MuchBoolean.new
+bool.given  # => nil
+bool.actual # => false
+
+MuchBoolean::FALSE_VALUES.each do |val|
+  bool = MuchBoolean.new(val)
+  bool.given    # => {val}
+  bool.actual   # => false
+  bool == false # => true
+  bool == true  # => false
+end
+
+['some-string', '1938', '1938.5', Date.today, Time.now].each do |val|
+  bool = MuchBoolean.new(val)
+  bool.given    # => {val}
+  bool.actual   # => true
+  bool == true  # => true
+  bool == false # => false
+end
+```
 
 ## Installation
 

data/lib/much-boolean.rb

@@ -1,5 +1,31 @@
 require "much-boolean/version"
 
-module MuchBoolean
-  # TODO: your code goes here...
+class MuchBoolean
+
+  FALSE_VALUES = [
+    nil,
+    0, '0',
+    false, 'false', 'False', 'FALSE', 'f', 'F',
+    'no', 'No', 'NO', 'n', 'N'
+  ].freeze
+
+  def self.convert(value)
+    !FALSE_VALUES.include?(value)
+  end
+
+  attr_reader :given, :actual
+
+  def initialize(given = nil)
+    @given  = given
+    @actual = self.class.convert(@given)
+  end
+
+  def ==(other_boolean)
+    if other_boolean.kind_of?(MuchBoolean)
+      self.actual == other_boolean.actual
+    else
+      self.actual == other_boolean
+    end
+  end
+
 end

data/lib/much-boolean/version.rb

@@ -1,3 +1,3 @@
-module MuchBoolean
-  VERSION = "0.0.1"
+class MuchBoolean
+  VERSION = "0.1.0"
 end

data/much-boolean.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |gem|
   gem.name        = "much-boolean"
   gem.version     = MuchBoolean::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
-  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.description = %q{Much boolean}
-  gem.summary     = %q{Much boolean}
-  gem.homepage    = "http://github.com/redding/much-boolean"
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com "]
+  gem.summary     = "An API for friendly boolean conversion, interpretation and handling"
+  gem.description = "An API for friendly boolean conversion, interpretation and handling"
+  gem.homepage    = "https://github.com/redding/much-boolean"
   gem.license     = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
@@ -18,6 +18,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.14"])
+  gem.add_development_dependency("assert", ["~> 2.15.0"])
 
 end

data/test/helper.rb

@@ -8,5 +8,3 @@ $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 require 'pry'
 
 require 'test/support/factory'
-
-# TODO: put test helpers here...

data/test/unit/much-boolean_tests.rb

@@ -0,0 +1,108 @@
+require 'assert'
+require 'much-boolean'
+
+class MuchBoolean
+
+  class UnitTests < Assert::Context
+    desc "MuchBoolean"
+    subject{ MuchBoolean }
+
+    should have_imeth :convert
+
+    should "know its false values" do
+      exp = [
+        nil,
+        0, '0',
+        false, 'false', 'False', 'FALSE', 'f', 'F',
+        'no', 'No', 'NO', 'n', 'N'
+      ]
+      assert_equal exp, subject::FALSE_VALUES
+    end
+
+    should "convert nil values as `false`" do
+      assert_false MuchBoolean.convert(nil)
+    end
+
+    should "convert 'zero-ish' values as `false`" do
+      [0, '0'].each do |val|
+        assert_false MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert 'false-ish' values as `false`" do
+      [false, 'false', 'False', 'FALSE', 'f', 'F'].each do |val|
+        assert_false MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert 'no-ish' values as `false`" do
+      ['no', 'No', 'NO', 'n', 'N'].each do |val|
+        assert_false MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert 'one-ish' values as `true`" do
+      [1, '1'].each do |val|
+        assert_true MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert 'true-ish' values as `true`" do
+      [true, 'true', 'True', 'TRUE', 't', 'T'].each do |val|
+        assert_true MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert 'yes-ish' values as `true`" do
+      ['yes', 'Yes', 'YES', 'y', 'Y'].each do |val|
+        assert_true MuchBoolean.convert(val)
+      end
+    end
+
+    should "convert all other values as `true`" do
+      [Factory.string, Factory.integer, Factory.date, Factory.time].each do |val|
+        assert_true MuchBoolean.convert(val)
+      end
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @actual = Factory.boolean
+      @bool = MuchBoolean.new(@actual)
+    end
+    subject{ @bool }
+
+    should have_reader :given, :actual
+
+    should "know its given and actual boolean values" do
+      assert_equal @actual, subject.given
+      assert_equal @actual, subject.actual
+
+      str  = Factory.string
+      bool = MuchBoolean.new(str)
+      assert_equal str, bool.given
+      assert_true  bool.actual
+    end
+
+    should "default its actual value to `false` when given nothing" do
+      bool = MuchBoolean.new
+      assert_nil   bool.given
+      assert_false bool.actual
+    end
+
+    should "know if it is equal to another much boolean or not" do
+      equal_bool = MuchBoolean.new(@actual)
+      not_bool   = MuchBoolean.new(!@actual)
+
+      assert_equal     equal_bool, subject
+      assert_not_equal not_bool,   subject
+      assert_equal     subject,    @actual
+      assert_not_equal subject,    !@actual
+    end
+
+  end
+
+end

metadata

@@ -1,74 +1,77 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: much-boolean
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Kelly Redding
 - Collin Redding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2016-01-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: assert
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-description: Much boolean
-email:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.15.0
+  type: :development
+  version_requirements: *id001
+description: An API for friendly boolean conversion, interpretation and handling
+email: 
 - kelly@kellyredding.com
-- collin.redding@me.com
+- "collin.redding@me.com "
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
+
+files: 
+- .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
-- Rakefile
 - lib/much-boolean.rb
 - lib/much-boolean/version.rb
 - log/.gitkeep
 - much-boolean.gemspec
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much-boolean_tests.rb
 - tmp/.gitkeep
-homepage: http://github.com/redding/much-boolean
-licenses:
+homepage: https://github.com/redding/much-boolean
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id002 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Much boolean
-test_files:
+summary: An API for friendly boolean conversion, interpretation and handling
+test_files: 
 - test/helper.rb
 - test/support/factory.rb
+- test/unit/much-boolean_tests.rb

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"