maybe_so 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f804350c62df7af2cf73422bfaa3a9cc219ce8a5
+  data.tar.gz: 0f5a5092a9149b39f1660f820f0cdd5ec1151a24
+SHA512:
+  metadata.gz: 0b7105d8f3f7e5a756b4169687f7d5f820f219f5660ddf5c22ff949a0c017ceed22f71e73f787e9d7c084d51882f71e3f239f2a61da9b915074f102a49f4b090
+  data.tar.gz: 6aa63ce3a34660f2ba0b01e0741774ff87b67ad7d861570a70dec5e88e79cf8fcd1a5f69a78347a1d984afd198e6b332f4b72c91ff5efe0b3714293c97dabe87

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,15 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - ruby-head
+  - jruby
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maybe_so.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Miller & Tanner Mares
+
+MIT License
+
+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 @@
+# Maybe So
+
+Ever get annoyed that ActiveRecord blows up if you set a boolean column to nil? Have you ever wanted to allow custom "truthy" values for booleans rather than just `true`, `false`, `0`, and `1`? Wish you could call `to_bool` on random objects and have it return something reasonable?
+
+Maybe So handles this for you!
+
+Tested on the following Rubies: MRI 1.9.3, 2.0.0, 2.1.x, JRuby (1.7.2 and newer).
+
+[![Build Status](https://secure.travis-ci.org/ministrycentered/maybe_so.svg?branch=master)](http://travis-ci.org/ministrycentered/maybe_so)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'maybe_so'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maybe_so
+
+## Usage
+
+### ActiveRecord
+
+Let's say you have an ActiveRecord attribute called `hidden` that you want to only be 0 or 1, never nil.
+
+```ruby
+add_column :products, :hidden, :boolean, default: false, null: false
+```
+
+Add the `boolean_attribute` class method on your class.
+
+```ruby
+class Product < ActiveRecord::Base
+  boolean_attribute :hidden
+end
+```
+
+By default, Maybe So accepts the following case insensitive values as `true`. Everything else is `false`. You can override these values with the `truthy_values` option (see below).
+
+```ruby
+true, "true", "Y", "Yes", 1, "1", "T"
+```
+
+### ActiveModel
+
+```ruby
+class Product
+  include ActiveModel::Model
+
+  boolean_attribute :hidden
+end
+```
+
+### Configuration options
+
+`boolean_attributes` accepts an options hash for the following:
+
+- `truthy_values`: array of values (will be coerced into strings when checking) to be considered truthy
+- `skip_validator`: this will not add the default `validates_inclusion_of` to ensure records are not valid unless they are set to `true` or `false`
+
+Example custom configuration:
+
+```ruby
+class Product < ActiveRecord::Base
+  boolean_attribute :hidden, truthy_values: ["Si"], skip_validator: true
+end
+```
+
+## Copyright
+
+Copyright (c) 2014 James Miller and Tanner Mares

data/Rakefile

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

data/lib/maybe_so/active_model/boolean_attribute.rb

@@ -0,0 +1,41 @@
+module MaybeSo
+  module ActiveModel
+    module BooleanAttribute
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def boolean_attribute(attribute, options = {})
+          truthy_values = options.delete(:truthy_values) || MaybeSo::DEFAULT_TRUTHY_VALUES
+          skip_validator = options.delete(:skip_validator)
+
+          # Override the attribute's ActiveModel or ActiveRecord setter to always set a boolean
+          #
+          # Example:
+          # def hidden=(hidden)
+          #   ...
+          # end
+          define_method "#{attribute}=" do |value|
+            boolean = truthy_values.include? value.to_s.downcase
+            if respond_to? :[]= # Use ActiveRecord setter
+              self[attribute.to_sym] = boolean
+            else
+              instance_variable_set("@#{attribute}", boolean)
+            end
+          end
+
+          # Add a validator that ensures only `true` or `false` are ever written to
+          # the database, regardless of whether or not the setter above was used for
+          # assignment.
+          unless skip_validator
+            instance_eval do
+              validates_inclusion_of attribute.to_sym, in: [true, false]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maybe_so/active_model.rb

@@ -0,0 +1,19 @@
+require "maybe_so/active_model/boolean_attribute"
+
+module ActiveModel
+  module Model
+    class << self
+      def included_with_boolean_attribute(base)
+        included_without_boolean_attribute(base)
+        base.class_eval do
+          include MaybeSo::ActiveModel::BooleanAttribute
+        end
+      end
+      alias_method_chain :included, :boolean_attribute
+    end
+  end
+end
+
+if defined?(::ActiveRecord)
+  ActiveRecord::Base.send(:include, MaybeSo::ActiveModel::BooleanAttribute)
+end

data/lib/maybe_so/core_ext/false_class.rb

@@ -0,0 +1,11 @@
+class FalseClass
+
+  def to_i
+    0
+  end
+
+  def to_bool
+    self
+  end
+
+end

data/lib/maybe_so/core_ext/fixnum.rb

@@ -0,0 +1,7 @@
+class Fixnum
+
+  def to_bool
+    self == 1
+  end
+
+end

data/lib/maybe_so/core_ext/nil_class.rb

@@ -0,0 +1,7 @@
+class NilClass
+
+  def to_bool
+    false
+  end
+
+end

data/lib/maybe_so/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+
+  def to_bool
+    MaybeSo::DEFAULT_TRUTHY_VALUES.include? self.downcase
+  end
+
+end

data/lib/maybe_so/core_ext/true_class.rb

@@ -0,0 +1,11 @@
+class TrueClass
+
+  def to_i
+    1
+  end
+
+  def to_bool
+    self
+  end
+
+end

data/lib/maybe_so/core_ext.rb

@@ -0,0 +1,5 @@
+require "maybe_so/core_ext/string"
+require "maybe_so/core_ext/fixnum"
+require "maybe_so/core_ext/true_class"
+require "maybe_so/core_ext/false_class"
+require "maybe_so/core_ext/nil_class"

data/lib/maybe_so/version.rb

@@ -0,0 +1,3 @@
+module MaybeSo
+  VERSION = "1.0.0"
+end

data/lib/maybe_so.rb

@@ -0,0 +1,13 @@
+require "maybe_so/core_ext"
+require "maybe_so/version"
+
+begin
+  require "active_model"
+  require "maybe_so/active_model"
+rescue LoadError
+end
+
+
+module MaybeSo
+  DEFAULT_TRUTHY_VALUES = %w(y yes true t 1)
+end

data/maybe_so.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maybe_so/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "maybe_so"
+  spec.version       = MaybeSo::VERSION
+  spec.authors       = ["James Miller", "Tanner Mares"]
+  spec.email         = ["bensie@gmail.com", "tannermares@gmail.com"]
+  spec.summary       = %q{Ruby boolean type casting}
+  spec.description   = %q{Ruby boolean type casting}
+  spec.homepage      = "https://github.com/ministrycentered/maybe_so"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", '~> 10'
+  spec.add_development_dependency "rspec", ">= 3.0.0", "< 4"
+  spec.add_development_dependency "activemodel", ">= 3.2.0", "< 5"
+end

data/spec/boolean_attribute_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe MaybeSo::ActiveModel::BooleanAttribute do
+  before do
+    @klass = Class.new
+    @klass.send(:include, ActiveModel::Model)
+  end
+
+  it "has the #boolean_attribute method on the class" do
+    expect(@klass).to respond_to(:boolean_attribute)
+  end
+
+  describe "#boolean_attribute" do
+    describe "attribute setter override" do
+      it "overrides the setter" do
+        @klass.boolean_attribute :hidden
+        expect(@klass.instance_methods).to include(:hidden=)
+      end
+
+      it "adds the attribute validator" do
+        @klass.boolean_attribute :hidden
+        expect(@klass.validators.map(&:attributes).flatten).to include(:hidden)
+      end
+
+      it "skips the validator if arg is provided" do
+        @klass.boolean_attribute :hidden, skip_validator: true
+        expect(@klass.validators.map(&:attributes).flatten).to_not include(:hidden)
+      end
+    end
+
+    context "when a boolean attribute is defined" do
+      before do
+        @klass.send(:attr_reader, :hidden)
+        @klass.boolean_attribute :hidden
+        @record = @klass.new
+      end
+
+      it "accepts truthy values and reads them as booleans" do
+        @record.hidden = "T"
+        expect(@record.hidden).to eq(true)
+
+        @record.hidden = "Yes"
+        expect(@record.hidden).to eq(true)
+      end
+
+      it "accepts falsy values and reads them as booleans" do
+        @record.hidden = "F"
+        expect(@record.hidden).to eq(false)
+
+        @record.hidden = "No"
+        expect(@record.hidden).to eq(false)
+      end
+
+      it "coerces nil to false" do
+        @record.hidden = nil
+        expect(@record.hidden).to eq(false)
+      end
+
+    end
+  end
+end

data/spec/false_class_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe FalseClass do
+  describe "#to_bool" do
+    it "returns false" do
+      expect(false.to_bool).to eq(false)
+    end
+  end
+
+  describe "#to_i" do
+    it "returns 0" do
+      expect(false.to_i).to eq(0)
+    end
+  end
+end

data/spec/fixnum_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Fixnum do
+  describe "#to_bool" do
+    context "when 1" do
+      it "returns true" do
+        expect(1.to_bool).to eq(true)
+      end
+    end
+
+    context "when 0" do
+      it "returns false" do
+        expect(0.to_bool).to eq(false)
+      end
+    end
+
+    context "when some other number" do
+      it "returns false" do
+        expect(42.to_bool).to eq(false)
+      end
+    end
+  end
+end

data/spec/nil_class_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe NilClass do
+  describe "#to_bool" do
+    it "returns false" do
+      expect(nil.to_bool).to eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "rspec"
+require "maybe_so"
+
+RSpec.configure do |config|
+  config.color = true
+end

data/spec/string_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe String do
+  describe "#to_bool" do
+    MaybeSo::DEFAULT_TRUTHY_VALUES.each do |truth|
+      context "when #{truth}" do
+        it "returns true" do
+          expect(truth.to_bool).to eq(true)
+        end
+      end
+    end
+
+    context "when any other string value" do
+      it "returns false" do
+        expect("foooo".to_bool).to eq(false)
+      end
+    end
+  end
+end

data/spec/true_class_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe TrueClass do
+  describe "#to_bool" do
+    it "returns true" do
+      expect(true.to_bool).to eq(true)
+    end
+  end
+
+  describe "#to_i" do
+    it "returns 1" do
+      expect(true.to_i).to eq(1)
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: maybe_so
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Miller
+- Tanner Mares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Ruby boolean type casting
+email:
+- bensie@gmail.com
+- tannermares@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/maybe_so.rb
+- lib/maybe_so/active_model.rb
+- lib/maybe_so/active_model/boolean_attribute.rb
+- lib/maybe_so/core_ext.rb
+- lib/maybe_so/core_ext/false_class.rb
+- lib/maybe_so/core_ext/fixnum.rb
+- lib/maybe_so/core_ext/nil_class.rb
+- lib/maybe_so/core_ext/string.rb
+- lib/maybe_so/core_ext/true_class.rb
+- lib/maybe_so/version.rb
+- maybe_so.gemspec
+- spec/boolean_attribute_spec.rb
+- spec/false_class_spec.rb
+- spec/fixnum_spec.rb
+- spec/nil_class_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb
+- spec/true_class_spec.rb
+homepage: https://github.com/ministrycentered/maybe_so
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby boolean type casting
+test_files:
+- spec/boolean_attribute_spec.rb
+- spec/false_class_spec.rb
+- spec/fixnum_spec.rb
+- spec/nil_class_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb
+- spec/true_class_spec.rb