attribool 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 469b94667c5be65a2901c9049f8290711c823fc7d08226140471c4c8820e66df
-  data.tar.gz: 526c90658fc7f1ac712383083a5c38ced3088f3ed91fc32af3a6801e7c0352cc
+  metadata.gz: 04a8612ea59018c8c1ace211692e9100676136ac77613627b8e8b0b295cf3bae
+  data.tar.gz: fe39cccfee3277bd92028940a54313e10861445a1b486d4791942875a3cb918a
 SHA512:
-  metadata.gz: 90be0ebf1c939bf765d0dd3848cf273b00606d4e00335418b1fc44de239ffb5f2042032525a22f9b205b9b10b6ff71126ba0a3c01449d2957fe328f4be354359
-  data.tar.gz: 48dbb1b70a57413523a962d29432343e5c7117f06ceae8063a7de1a5306595bab5f469db638a25bed1074efee037982e4a776c75334168e9d6e0064359e9e240
+  metadata.gz: 762bd93ec17802176022253614871443f0e388892558d455b697b90e69d26be00917f6cd5b803f105e6ace168985e85a4c14305059e92886500bbb3f035efcff
+  data.tar.gz: 1b125fffc61d42dc9a8b63b77b625f57786ca03c44a2045a7bb1685bb5ea1d6c8e36ffa5fa6104b14fde943e79bedcfb8d5b92da88a59c1b0dd1f692b67098d2

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install
+        bundle exec rake test

data/.gitignore

@@ -1,2 +1,3 @@
 attribool-*.gem
 coverage/*
+docs/*

data/README.md

@@ -1,4 +1,10 @@
 # Attribool
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fattribool%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/attribool/goto?ref=master)
+[![Gem Version](https://badge.fury.io/rb/attribool.svg)](https://badge.fury.io/rb/attribool)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> Pre-release version. Everything works, but not everything is documented.
+
 Ruby macros for creating boolean methods for attributes that may or may not be
 booleans themselves. This is done via coercion based on truthiness. For example,
 if you have an attribute of `@name`, and you want to know if `@name` is not
@@ -17,6 +23,8 @@ Macros also exist for `bool_writer` and `bool_accessor`. When a writer
 method is defined, the value will always be coerced into a boolean before
 setting the attribute.
 
+You can read the documentation [here](https://evanthegrayt.github.io/attribool/).
+
 ## Installation
 #### Via Gemfile
 ```ruby
@@ -41,7 +49,7 @@ bundle exec rake install
 require 'attribool'
 
 class Person
-  extend Attribool
+  include Attribool
 
   attr_accessor :name
   bool_reader :name
@@ -63,11 +71,11 @@ person.name?
 require 'attribool'
 
 class Person
-  extend Attribool
+  include Attribool
 
   attr_accessor :name
   bool_reader :name, method: :named?
-  bool_reader :name, prefix: :has?
+  bool_reader :name, prefix: :has
 end
 
 person = Person.new
@@ -86,7 +94,7 @@ person.has_name?
 require 'attribool'
 
 class Person
-  extend Attribool
+  include Attribool
 
   attr_accessor :age
   # In the condition lambdas, the argument refers to the attribute's value.
@@ -111,7 +119,7 @@ person.adult?
 require 'attribool'
 
 class Person
-  extend Attribool
+  include Attribool
 
   bool_accessor :living
 end
@@ -123,5 +131,17 @@ person.living?
 person.living = true
 person.living?
 # true, because @living is true.
-# Be aware -- if you pass a string, it will be coerced to true!
+# Be aware -- if you pass anything truthy, it will be coerced to true!
 ```
+
+## Reporting Bugs and Requesting Features
+If you have an idea or find a bug, please [create an
+issue](https://github.com/evanthegrayt/attribool/issues/new). Just make sure
+the topic doesn't already exist. Better yet, you can always submit a Pull
+Request.
+
+## Self-Promotion
+I do these projects for fun, and I enjoy knowing that they're helpful to people.
+Consider starring [the repository](https://github.com/evanthegrayt/attribool)
+if you like it! If you love it, follow me [on
+Github](https://github.com/evanthegrayt)!

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_dir = 'docs'
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 

data/attribool.gemspec

@@ -19,10 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] =
-    'https://github.com/evanthegrayt/attribool'
-  spec.metadata['documentation_uri'] =
-    'https://evanthegrayt.github.io/attribool/doc/index.html'
+  spec.metadata['source_code_uri'] = 'https://github.com/evanthegrayt/attribool'
+  spec.metadata['documentation_uri'] = 'https://evanthegrayt.github.io/attribool/'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/attribool.rb

@@ -3,7 +3,7 @@
 ##
 # Adds macros and methods for dealing with boolean attributes.
 module Attribool
-  def self.included(klass)
+  def self.included(klass) # :nodoc:
     klass.extend(ClassMethods)
   end
 
@@ -36,7 +36,7 @@ module Attribool
         ivar = instance_variable_get("@#{attribute}")
         raise TypeError, "#{attribute} is nil" if ivar.nil? && !allow_nil
 
-        condition ? condition.call(ivar) : to_boolean(ivar)
+        condition ? condition.call(ivar) : !!(ivar)
       end
     end
 
@@ -49,9 +49,11 @@ module Attribool
     # @kwarg [Boolean] strict:
     def bool_writer(attribute, strict: false)
       define_method("#{attribute}=") do |v|
-        validate_boolean(v) if strict
+        if strict && ![TrueClass, FalseClass].include?(v.class)
+          raise ArgumentError, 'Argument must be a boolean'
+        end
 
-        instance_variable_set("@#{attribute}", to_boolean(v))
+        instance_variable_set("@#{attribute}", !!v)
       end
     end
 
@@ -65,32 +67,4 @@ module Attribool
       bool_writer(attribute)
     end
   end
-
-  ##
-  # Is the argument a boolean?
-  #
-  # @param [Object] attribute
-  #
-  # @return [Boolean]
-  def boolean?(attribute)
-    [TrueClass, FalseClass].include?(attribute.class)
-  end
-
-  ##
-  # Converts an Object to a boolean.
-  #
-  # @param [Object] attribute
-  #
-  # @return [Boolean]
-  def to_boolean(attribute)
-    !!attribute
-  end
-
-  private
-
-  ##
-  # Raises if argument is not a boolean.
-  def validate_boolean(attribute) # :nodoc:
-    raise ArgumentError, 'Argument must be a boolean' unless boolean?(attribute)
-  end
 end

data/lib/attribool/version.rb

@@ -21,7 +21,7 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 1
+    PATCH = 2
 
     ##
     # Version as +MAJOR.MINOR.PATCH+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,6 +70,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -86,7 +87,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/evanthegrayt/attribool
   source_code_uri: https://github.com/evanthegrayt/attribool
-  documentation_uri: https://evanthegrayt.github.io/attribool/doc/index.html
+  documentation_uri: https://evanthegrayt.github.io/attribool/
 post_install_message:
 rdoc_options: []
 require_paths: