attribool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 469b94667c5be65a2901c9049f8290711c823fc7d08226140471c4c8820e66df
+  data.tar.gz: 526c90658fc7f1ac712383083a5c38ced3088f3ed91fc32af3a6801e7c0352cc
+SHA512:
+  metadata.gz: 90be0ebf1c939bf765d0dd3848cf273b00606d4e00335418b1fc44de239ffb5f2042032525a22f9b205b9b10b6ff71126ba0a3c01449d2957fe328f4be354359
+  data.tar.gz: 48dbb1b70a57413523a962d29432343e5c7117f06ceae8063a7de1a5306595bab5f469db638a25bed1074efee037982e4a776c75334168e9d6e0064359e9e240

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    attribool (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.3.5)
+    power_assert (2.0.0)
+    rake (13.0.3)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    test-unit (3.4.0)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attribool!
+  rake (~> 13.0, >= 13.0.1)
+  simplecov
+  test-unit (~> 3.3, >= 3.3.5)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Evan Gray
+
+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,127 @@
+# Attribool
+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
+`nil`, you can declare `bool_reader :name`, which will define the method
+`name?`. This method will return true if `@name` is truthy.
+
+The `bool_reader` also comes with some handy options. For example, you can
+[define a method name](#a-bool_reader-with-method-name-or-prefix) that makes
+more sense.  Using the same example, as above, if your attribute is `@name`, but
+you'd like for your boolean method to be called `named?`, you can use
+`bool_reader :name, method: :named?`.
+[Conditionals](#a-bool_reader-with-method-name-and-conditional) can also be set
+with lambdas via the `condition:` keyword argument.
+
+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.
+
+## Installation
+#### Via Gemfile
+```ruby
+gem 'attribool'
+```
+
+#### Via rubygems
+```sh
+gem install attribool
+```
+
+#### From source
+```sh
+git clone https://github.com/evanthegrayt/attribool.git
+cd attribool
+bundle exec rake install
+```
+
+## Examples
+#### Standard bool_reader
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  attr_accessor :name
+  bool_reader :name
+end
+
+person = Person.new
+person.name?
+# false, because @name is nil.
+
+person.name = 'John Smith'
+person.name
+# "John Smith"
+person.name?
+# true, because @name is truthy.
+```
+
+#### A bool_reader with method name or prefix
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  attr_accessor :name
+  bool_reader :name, method: :named?
+  bool_reader :name, prefix: :has?
+end
+
+person = Person.new
+person.named?
+person.has_name?
+# false, because @name is nil.
+
+person.name = 'John Smith'
+person.named?
+person.has_name?
+# true, because @name is truthy.
+```
+
+#### A bool_reader with method name and conditional
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  attr_accessor :age
+  # In the condition lambdas, the argument refers to the attribute's value.
+  bool_reader :age, method: :adult?, condition: ->(a) { a.to_i >= 18 }
+end
+
+person = Person.new
+person.adult?
+# false, because @age is nil, which the to_i converts to 0.
+
+person.age = 10
+person.adult?
+# false, because @age is less than 18.
+
+person.age = 20
+person.adult?
+# true, because @age is greater than 18.
+```
+
+#### Standard bool_accessor
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  bool_accessor :living
+end
+
+person = Person.new
+person.living?
+# false, because @living is nil.
+
+person.living = true
+person.living?
+# true, because @living is true.
+# Be aware -- if you pass a string, it will be coerced to true!
+```

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'lib/attribool'
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib']
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+task default: :test

data/attribool.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/attribool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'attribool'
+  spec.version       = Attribool::Version.to_s
+  spec.authors       = ['Evan Gray']
+  spec.email         = 'evanthegrayt@vivaldi.net'
+  spec.license       = 'MIT'
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+
+  spec.summary       = %(Macros for creating boolean attribute methods)
+  spec.description   = %(Macros for creating boolean attribute methods)
+  spec.homepage      = 'https://github.com/evanthegrayt/attribool'
+
+  unless spec.respond_to?(:metadata)
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
+end

data/lib/attribool.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+##
+# Adds macros and methods for dealing with boolean attributes.
+module Attribool
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  ##
+  # Class methods to be added to the class when included.
+  module ClassMethods
+    ##
+    # Creates a method that returns a boolean for attributes that may or may
+    # not be booleans themselves.
+    #
+    # @param [Symbol, String] attribute
+    #
+    # @kwarg [Boolean] allow_nil:
+    #
+    # @kwarg [Lambda] condition:
+    #
+    # @kwarg [Symbol, String] method:
+    #
+    # @kwarg [Symbol, String] prefix:
+    def bool_reader(
+      attribute,
+      allow_nil: true,
+      condition: nil,
+      prefix: nil,
+      method: nil
+    )
+      method ||= "#{attribute}?"
+      method = "#{prefix}_#{method}" if prefix
+      define_method(method) do
+        ivar = instance_variable_get("@#{attribute}")
+        raise TypeError, "#{attribute} is nil" if ivar.nil? && !allow_nil
+
+        condition ? condition.call(ivar) : to_boolean(ivar)
+      end
+    end
+
+    ##
+    # Creates a writer for boolean attributes. Always coerces to boolean based
+    # on truthiness.
+    #
+    # @param [Symbol, String] attribute
+    #
+    # @kwarg [Boolean] strict:
+    def bool_writer(attribute, strict: false)
+      define_method("#{attribute}=") do |v|
+        validate_boolean(v) if strict
+
+        instance_variable_set("@#{attribute}", to_boolean(v))
+      end
+    end
+
+    ##
+    # Creates a simple reader and writer for booleans. This should only be used
+    # when the attribute should only ever be +true+ or +false+.
+    #
+    # @param [Symbol, String] attribute
+    def bool_accessor(attribute)
+      bool_reader(attribute)
+      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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Attribool
+  ##
+  # Module that contains all gem version information. Follows semantic
+  # versioning. Read: https://semver.org/
+  module Version
+    ##
+    # Major version.
+    #
+    # @return [Integer]
+    MAJOR = 0
+
+    ##
+    # Minor version.
+    #
+    # @return [Integer]
+    MINOR = 0
+
+    ##
+    # Patch version.
+    #
+    # @return [Integer]
+    PATCH = 1
+
+    ##
+    # Version as +MAJOR.MINOR.PATCH+
+    #
+    # @return [String]
+    def self.to_s
+      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: attribool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Gray
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+description: Macros for creating boolean attribute methods
+email: evanthegrayt@vivaldi.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- attribool.gemspec
+- lib/attribool.rb
+- lib/attribool/version.rb
+homepage: https://github.com/evanthegrayt/attribool
+licenses:
+- MIT
+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
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Macros for creating boolean attribute methods
+test_files: []