attribute_boolean 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57169cbf013b228b30041ef730210bc853015e82
+  data.tar.gz: b5571255127263ac9c222318fd86918248623899
+SHA512:
+  metadata.gz: c9db8fccc47868be968354f2155525a7c85d621b1bda1662ea03b979336b308a3a366748d8d31cfb886d33c32151886854e8bc697cffb081c4274c3b52c5e81a
+  data.tar.gz: 7fe570f20d134186ac5e47d3a67d96212c53940414e6575d5dec77c26c767c2400c6570d60059e95b7c872f22a340f87dbda5df845b0e7a083bece1c1583fcad

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alex McHale
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex McHale
+
+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,106 @@
+# Attribute Boolean
+
+The purpose of this gem is to provide an `attr_boolean` shortcut to classes.
+This shortcut creates accessors that, when assigned to with a variety of
+"falsey" or "truthy" data, can be interpreted as intended.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attribute_boolean'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attribute_boolean
+
+## Usage
+
+In a standard Ruby class, you might have something like this:
+
+```ruby
+class Calculation
+
+  include AttributeBoolean
+
+  attr_boolean :complete
+
+end
+```
+
+This provides you with the `"#{attr}="` and `"#{attr}?"` methods:
+
+```ruby
+c = Calculation.new
+
+c.complete = "1"
+c.complete? #=> true
+
+c.complete = "0"
+c.complete? #=> false
+
+c.complete = "yes"
+c.complete? #=> true
+
+c.complete = "no"
+c.complete? #=> false
+```
+
+The default values that are interpreted as `false` is:
+
+```ruby
+[ false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF', 'n', 'N', 'no', 'NO' ]
+```
+
+This can be customized globally like this:
+
+```ruby
+AttributeBoolean.false_values = [ "dunno", -1, :negative ]
+AttributeBoolean.false_values += [ "no way", 0 ]
+```
+
+Or the `false_values` list can be set individually per `attr_boolean` call.
+Using this option will replace the global list for that attribute.
+
+```ruby
+attr_boolean :complete, false_values: [ 'it is not complete', 'not completed', :nope ]
+attr_boolean :in_progress, false_values: Set.new(:no, 'nope')
+```
+
+Specify a default value for the attribute that will be used if it (1) hasn't
+been set, or (2) has been set to nil. The value passed to `default` is
+casted to a boolean using `!!default`.
+
+```ruby
+attr_boolean :complete, default: true
+```
+
+AttributeBoolean converts all symbols to strings when evaluating truthiness:
+
+```
+obj.complete = :no
+obj.complete? #=> false
+
+obj.complete = :yes
+obj.complete? #=> true
+```
+
+### Rails
+
+If Rails is loaded when this gem loads, it will automatically inject the
+`AttributeBoolean` module into `ActiveRecord::Base`, preventing the need to
+call `include AttributeBoolean` on ActiveRecord classes.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/attribute_boolean/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib", "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/attribute_boolean.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attribute_boolean'
+
+Gem::Specification.new do |spec|
+  spec.name          = "attribute_boolean"
+  spec.version       = AttributeBoolean::VERSION
+  spec.authors       = ["Alex McHale"]
+  spec.email         = ["alex@anticlever.com"]
+  spec.summary       = %q{A gem for adding attr_boolean to objects}
+  spec.description   = %q{A gem for adding attr_boolean to objects, assigning by various 'falsey' values}
+  spec.homepage      = "https://github.com/alexmchale/attribute_boolean"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/attribute_boolean.rb

@@ -0,0 +1,86 @@
+module AttributeBoolean
+
+  VERSION = "0.0.1"
+
+  module ClassMethods
+    def attr_boolean(*args)
+      options =
+        if args.last.kind_of?(Hash)
+          args.pop
+        else
+          {}
+        end
+
+      default_value =
+        if options.has_key?(:default)
+          !! options[:default]
+        elsif options.has_key?("default")
+          !! options["default"]
+        else
+          false
+        end
+
+      false_values =
+        if options.has_key?(:false_values)
+          options[:false_values]
+        elsif options.has_key?("false_values")
+          options["false_values"]
+        end
+
+      args.each do |name|
+        ivar = "@#{ name }"
+
+        define_method("#{ name }?") do
+          value = instance_variable_get(ivar)
+
+          if value == nil
+            default_value
+          else
+            !! value
+          end
+        end
+
+        define_method("#{ name }=") do |value|
+          is_true =
+            if value == nil
+              default_value
+            elsif false_values
+              ! false_values.include?(value.to_s)
+            else
+              ! AttributeBoolean.false_values.include?(value.to_s)
+            end
+
+          instance_variable_set(ivar, is_true)
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  def self.reset_false_values!
+    @false_values = [ false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF', 'n', 'N', 'no', 'NO' ]
+  end
+
+  def self.false_values
+    @false_values or reset_false_values!
+  end
+
+  def self.false_values=(false_values)
+    @false_values = false_values
+  end
+
+  # Mix AttributeBoolean into ActiveRecord::Base if Rails is loaded.
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer "attribute_boolean.initialize" do
+        ActiveSupport.on_load(:active_record) do
+          ActiveRecord::Base.send(:include, AttributeBoolean)
+        end
+      end
+    end
+  end
+
+end

data/test/attr_boolean_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+class AttrBooleanTest < Minitest::Test
+
+  def setup
+    @class =
+      Class.new do
+        include AttributeBoolean
+        attr_boolean :field
+      end
+
+    @obj = @class.new
+  end
+
+  def test_truthiness
+    [ "y", "yes", true, 1, 2, :y ].each do |value|
+      @obj.field = value
+      assert_equal true, @obj.field?, "expected #{ value.inspect } to result in true"
+    end
+  end
+
+  def test_falsiness
+    [ false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF', 'n', 'N', 'no', 'NO' ].each do |value|
+      @obj.field = value
+      assert_equal false, @obj.field?, "expected #{ value.inspect } to result in false"
+    end
+  end
+
+end

data/test/default_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+class DefaultTest < Minitest::Test
+
+  def setup
+    @class =
+      Class.new do
+        include AttributeBoolean
+        attr_boolean :default_false, default: false
+        attr_boolean :default_true, default: true
+      end
+
+    @obj = @class.new
+  end
+
+  def test_default_false
+    assert_equal false, @obj.default_false?, "expected default_false to default to false"
+
+    @obj.default_false = true
+    assert_equal true, @obj.default_false?, "expceted default_false to set to true"
+
+    @obj.default_false = nil
+    assert_equal false, @obj.default_false?, "expected default_false to revert to false"
+  end
+
+  def test_default_true
+    assert_equal true, @obj.default_true?, "expected default_true to default to true"
+
+    @obj.default_true = false
+    assert_equal false, @obj.default_true?, "expceted default_true to set to false"
+
+    @obj.default_true = nil
+    assert_equal true, @obj.default_true?, "expected default_true to revert to true"
+  end
+
+end

data/test/global_false_values_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+
+class GlobalFalseValuesTest < Minitest::Test
+
+  def setup
+    @class =
+      Class.new do
+        include AttributeBoolean
+        attr_boolean :finished
+      end
+
+    @obj = @class.new
+  end
+
+  def test_custom_false
+    AttributeBoolean.false_values = [ "no way" ]
+
+    assert_equal [ "no way" ], AttributeBoolean.false_values
+
+    @obj.finished = false
+    assert_equal true, @obj.finished?, "returns true for values not listed in the global false values"
+
+    @obj.finished = "no way"
+    assert_equal false, @obj.finished?, "returns false for value listed in the global false values"
+
+    @obj.finished = :"no way"
+    assert_equal false, @obj.finished?, "also returns false for symbolized versions of those values"
+  end
+
+  def teardown
+    AttributeBoolean.reset_false_values!
+  end
+
+end

data/test/local_false_values_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class LocalFalseValuesTest < Minitest::Test
+
+  def setup
+    @class =
+      Class.new do
+        include AttributeBoolean
+        attr_boolean :finished, false_values: [ "nope", "nut uh" ]
+      end
+
+    @obj = @class.new
+  end
+
+  def test_custom_false
+    @obj.finished = false
+    assert_equal true, @obj.finished?, "returns true for values not listed in the global false values"
+
+    @obj.finished = "nut uh"
+    assert_equal false, @obj.finished?, "returns false for value listed in the global false values"
+
+    @obj.finished = :"nut uh"
+    assert_equal false, @obj.finished?, "also returns false for symbolized versions of those values"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/pride"
+
+require "attribute_boolean"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: attribute_boolean
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex McHale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A gem for adding attr_boolean to objects, assigning by various 'falsey'
+  values
+email:
+- alex@anticlever.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- attribute_boolean.gemspec
+- lib/attribute_boolean.rb
+- test/attr_boolean_test.rb
+- test/default_test.rb
+- test/global_false_values_test.rb
+- test/local_false_values_test.rb
+- test/test_helper.rb
+homepage: https://github.com/alexmchale/attribute_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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for adding attr_boolean to objects
+test_files:
+- test/attr_boolean_test.rb
+- test/default_test.rb
+- test/global_false_values_test.rb
+- test/local_false_values_test.rb
+- test/test_helper.rb
+has_rdoc: