predicateable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 941c76b3af813ee5f06646db352801907dd83a4aa5642a73ef7acfe103abac55
+  data.tar.gz: c5294a45ff7b2e4ac9ab0067cad3849addcf2dfe72c3939042fc55888594fa15
+SHA512:
+  metadata.gz: 5594292717451ef97c6e4fa9492240d93ce53a99738b224ed3b077b10ec0e4dba86b6b58ed715d7bf96bb686c1da0bba292d6d9bdccfb729808be7a20c812c8a
+  data.tar.gz: 16917996f9ba3a785bbe10fd96b02c0f0c26f8a42cfed7998567110b052f5375fb3dcb309e13cc3a867958f73166a999bbedd43a59b29bc5ffe615161f1923eb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Naoki Nishiguchi
+
+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,112 @@
+# Predicateable
+
+**Predicateable** is a Ruby mixin that dynamically defines predicate methods (like `admin?`, `young?`) based on the return value of a method. It's ideal for cleanly querying symbolic states without writing repetitive predicate methods.
+
+## Features
+
+- Defines `?` predicate methods dynamically.
+- Supports prefixing (e.g. `account_type_admin?`).
+- `strict:` option ensures only symbols are matched.
+- Works seamlessly with `respond_to?`.
+- Pure Ruby, no dependencies.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem "predicateable"
+````
+
+And run:
+
+```sh
+bundle install
+```
+
+Or install it directly:
+
+```sh
+gem install predicateable
+```
+
+## Usage
+
+### Basic Example
+
+```ruby
+class User
+  include Predicateable
+
+  attr_reader :age, :account_type
+
+  predicate :age_group, [:young, :middle, :old]
+  predicate :account_type, [:guest, :member, :admin], prefix: true
+
+  def initialize(age:, account_type:)
+    @age = age
+    @account_type = account_type
+  end
+
+  def age_group
+    case age
+    when 0...30 then :young
+    when 30...60 then :middle
+    else :old
+    end
+  end
+end
+
+user = User.new(age: 45, account_type: :admin)
+
+user.middle?                # => true
+user.age_group              # => :middle
+user.account_type_admin?    # => true
+user.account_type_guest?    # => false
+```
+
+### Strict Mode
+
+If you want predicate checks to pass only when the method returns a **Symbol**, enable `strict: true`:
+
+```ruby
+class User
+  include Predicateable
+
+  attr_reader :role
+
+  predicate :role, [:editor, :viewer], strict: true
+
+  def initialize(role:)
+    @role = role
+  end
+end
+
+User.new(role: :editor).editor?  # => true
+User.new(role: "editor").editor? # => false (strict mode)
+```
+
+## Behavior Summary
+
+| Feature         | Description                                    |
+| --------------- | ---------------------------------------------- |
+| `prefix:`       | Adds method name prefix (e.g. `account_type_`) |
+| `strict:`       | Only matches `Symbol` values                   |
+| `respond_to?`   | Works with predicate methods                   |
+| `NoMethodError` | Raised when calling undefined predicates       |
+
+## Testing
+
+This gem uses [Minitest](https://github.com/minitest/minitest). To run tests:
+
+```sh
+bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome! If you have ideas for improvement or questions, feel free to open an issue.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE.txt](LICENSE.txt) file for details.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/predicateable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Predicateable
+  VERSION = "0.1.0"
+end

data/lib/predicateable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "predicateable/version"
+
+module Predicateable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def predicate(name, values, prefix: false, strict: false)
+      values.each do |value|
+        method = prefix ? "#{name}_#{value}?" : "#{value}?"
+
+        define_method(method) do
+          actual = send(name)
+
+          if strict
+            actual == value
+          else
+            actual.to_s == value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/sig/predicateable.rbs

@@ -0,0 +1,4 @@
+module Predicateable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: predicateable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naoki Nishiguchi
+bindir: exe
+cert_chain: []
+date: 1980-01-02 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+description: Predicateable allows you to define predicate methods (like `admin?`)
+  based on a method that returns a Symbol. Similar to Rails enums, with optional strict
+  checking and prefix support.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/predicateable.rb
+- lib/predicateable/version.rb
+- sig/predicateable.rbs
+homepage: https://github.com/nsgc/predicateable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nsgc/predicateable
+  source_code_uri: https://github.com/nsgc/predicateable.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Dynamically defines predicate methods based on symbolic return values.
+test_files: []