attr_chainable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 354c7786fc972e705ae212ebbf431f5d5473a3f4dad70bd74a4797442d2b822d
+  data.tar.gz: d01bbcbed9988acfd06f34dc47be7edeead63bf847194d769ecf3d2348ea5085
+SHA512:
+  metadata.gz: 4980d98a4230d9dedd436772b9f06827a40e281dd79fe6d184b5b91698f570f9feb84d9515a625fa9c5a722eb7a251dda4d2c70de1cc21d88f8c30d7d3aec19f
+  data.tar.gz: 53cfeb9cddeb1cf0bad658f6fce5decf595ef25a48ae2ebea37bc5c432044f56b4e80cb8a78e9d3a01f9a94137bf2b2f9cb24470274b44c9508750d341a6deb7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-04-13
+
+### Added
+
+- Initial release of `attr_chainable`.
+- Provides `attr_chainable` class method to define chainable attribute setters.

data/README.md

@@ -0,0 +1,71 @@
+# attr_chainable
+
+`attr_chainable` provides a simple way to define attributes on a Ruby class that support method chaining for setting values. This allows for a fluent interface when configuring objects.
+
+When adding this gem, it will attach `attr_chainable` methods to your class, enabling you to set multiple attributes in a single line of code.
+
+A constant `Nothing` is also defined in the global scope, which can be used as a placeholder for optional attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attr_chainable'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install attr_chainable
+```
+
+## Usage
+
+Use the `attr_chainable` class method to define chainable attributes:
+
+```ruby
+class MyClass
+  # Define chainable attributes :name and :age
+  attr_chainable :name, :age
+end
+
+# Create an instance
+instance = MyClass.new
+
+# Set attributes using chaining
+instance.name("Alice").age(30)
+
+# Get attribute values
+puts instance.name # Output: Alice
+puts instance.age  # Output: 30
+
+# Setting an attribute returns the object itself, allowing further chaining
+another_instance = MyClass.new
+result = another_instance.name("Bob")
+puts result.object_id == another_instance.object_id # Output: true
+result.age(25)
+puts another_instance.age # Output: 25
+```
+
+When the generated methods are called with an argument, they set the corresponding instance variable and return `self`. When called without an argument, they return the current value of the instance variable.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/your_username/attr_chainable](https://gitlab.com/your_username/attr_chainable).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/attr_chainable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Nothing = Object.new
+class << Nothing
+  def to_s = "Nothing"
+  def inspect = "Nothing"
+end
+Nothing.freeze
+
+Object.define_singleton_method(
+  :attr_chainable
+) do |*attributes|
+  attributes.each do |attribute|
+    instance_variable = "@#{attribute}".to_sym
+
+    define_method(attribute) do |value = Nothing|
+      return instance_variable_get(instance_variable) if value == Nothing
+
+      instance_variable_set(instance_variable, value)
+
+      self
+    end
+  end
+end

data/sig/attr_chainable.rbs

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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: attr_chainable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yacine Petitprez
+bindir: exe
+cert_chain: []
+date: 2025-04-13 00:00:00.000000000 Z
+dependencies: []
+description: "`attr_chainable` provides a simple way to define attributes on a Ruby
+  class that support method chaining for setting values. This allows for a fluent
+  interface when configuring objects."
+email:
+- anykeyh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/attr_chainable.rb
+- sig/attr_chainable.rbs
+homepage: https://gitlab.com/anykeyh/attr_chainable
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/anykeyh/attr_chainable
+  source_code_uri: https://gitlab.com/anykeyh/attr_chainable
+  changelog_uri: https://gitlab.com/anykeyh/attr_chainable/-/blob/main/CHANGELOG.md
+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.3
+specification_version: 4
+summary: Define chainable attribute setters for Ruby classes.
+test_files: []