attr_with_class 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8724912235d91b86a21dd395658438f82aac4c66af13ff74416a518fcb396591
+  data.tar.gz: 2d358460c9fd4ea8fdf1c8f4afbfdd83c0b5c385a2441706836c6620a33a96f3
+SHA512:
+  metadata.gz: 5f15930bce81aaebaea5f5f20544df5d9bf51dea92d70d5d6847a60c5cf4510e75704da1e488555500ec765517317998d8ad60ab71df9082acbdde42f30cb197
+  data.tar.gz: f8e85d65317f5d661638bf39b212d015e919de0c78b1dc5be1d572007733d7a2b57810305b30fe0a527489c56e22b68e94ae60009fb34b21b5b62998fed96d0c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.gem

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.10
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in attr_with_class.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    attr_with_class (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.18.1)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  attr_with_class!
+  bundler (~> 4.0.0)
+  minitest (~> 5.18.0)
+  rake (~> 13.0.0)
+
+CHECKSUMS
+  attr_with_class (0.1.0)
+  minitest (5.18.1) sha256=ab5ee381871aaddc3a6aa2a6abcab5c4590fec9affc20947d63f312a0fe4e9cd
+  rake (13.0.6) sha256=5ce4bf5037b4196c24ac62834d8db1ce175470391026bd9e557d669beeb19097
+
+BUNDLED WITH
+  4.0.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bobby Pennington
+
+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,77 @@
+# AttrWithClass
+
+Ruby metaprogramming helpers that create type-safe attribute accessors
+
+```ruby
+class SomeClass
+  attr_accessor_with_class String, :some_string, :some_other_string
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'attr_with_class'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_with_class
+
+## Usage
+
+```ruby
+class Person
+  attr_accessor_with_class String, :name, :email
+
+  attr_accessor_with_non_negative_integer Integer, :age
+
+  attr_accessor_with_handler :favourite_ice_cream do |val|
+    raise ArgumentError, "must be a valid flavour" unless ["vanilla", "chocolate"].include(val)
+    val
+  end
+end
+
+person = Person.new
+
+person.name = "Alice"    # works
+person.name = 123        # raises ArgumentError: 123 is not a String
+
+person.age = 30          # works
+person.age = -1          # raises ArgumentError: -1 is not a non-negative integer
+
+person.favourite_ice_cream = "vanilla"
+person.favourite_ice_cream = "pistachio" #raises ArgumentError: must be a valid flavour
+```
+
+### Available Methods
+
+`attr_writer / attr_accessor _with_handler(*attrs, &block)`
+
+writer or accessor with custom validation/transformation block
+
+
+`attr_writer / attr_accessor _with_class(klass, *attrs)`
+
+writer or accessor that enforces class (or subclass) 
+
+
+`attr_writer / attr_accessor _with_non_negative_integer(*attrs)`
+
+writer or accessor that enforces non-negative integers 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bpenn9/attr_with_class.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/attr_with_class.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "attr_with_class/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "attr_with_class"
+  spec.version       = AttrWithClass::VERSION
+  spec.authors       = ["Bobby Pennington"]
+  spec.email         = ["bobby.pennington@shopify.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{A couple variations of attr_accessor which support typecheking and custom setter handling}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/bpenn9/attr_with_class"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 4.0.0"
+  spec.add_development_dependency "rake", "~> 13.0.0"
+  spec.add_development_dependency "minitest", "~> 5.18.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "attr_with_class"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example.rb

@@ -0,0 +1,15 @@
+require "attr_with_class"
+
+class A 
+  attr_accessor_with_class String, :must_be_a_string
+end
+
+#################
+
+a = A.new
+
+a.must_be_a_string = "abcd"
+
+# error! 
+# attr_with_class throws an error because 5 is not a string
+a.must_be_a_string = 5

data/lib/attr_with_class/version.rb

@@ -0,0 +1,3 @@
+module AttrWithClass
+  VERSION = "0.1.0"
+end

data/lib/attr_with_class.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "attr_with_class/version"
+
+# references (for Dev Degree)
+# https://stackoverflow.com/questions/900419/how-to-understand-the-difference-between-class-eval-and-instance-eval
+# https://stackoverflow.com/questions/74885066/understanding-class-eval-and-instance-eval
+# https://blog.appsignal.com/2023/07/26/an-introduction-to-metaprogramming-in-ruby.html
+# https://medium.com/@camfeg/dynamic-method-definition-with-rubys-define-method-b3ffbbee8197
+
+module AttrWithClass
+  def self.verify_class_or_subclass(expected_class, value)
+    raise(ArgumentError, "#{value} is not a #{expected_class}.") unless value.class <= expected_class
+  end
+
+  def self.verify_non_negative_integer(value)
+    raise(ArgumentError, "#{value} is not a non-negative integer (must be >= 0).") \
+      unless value.class <= Integer && value >= 0
+  end
+end
+
+# pass writes to any of attr_symbols to the handler block
+
+def attr_writer_with_handler(*attr_symbols, &handler)
+  attr_symbols.each do |attr_symbol|
+    attr_setter_symbol = :"#{attr_symbol}="
+    instance_attr_symbol = :"@#{attr_symbol}"
+
+    define_method(attr_setter_symbol) do |new_attr_value|
+      new_attr_value = handler.call(new_attr_value)
+      instance_variable_set(instance_attr_symbol, new_attr_value)
+    end
+  end
+end
+
+def attr_accessor_with_handler(*attr_symbols, &handler)
+  attr_writer_with_handler(*attr_symbols, &handler)
+  attr_reader(*attr_symbols)
+end
+
+# writed to any of attr_symbols are checked for class or subclass
+# special case of attr_writer_with_handler / attr_accessor_with_handler
+
+def attr_writer_with_class(expected_class, *attr_symbols)
+  attr_writer_with_handler(*attr_symbols) do |new_attr_value|
+    AttrWithClass.verify_class_or_subclass(expected_class, new_attr_value)
+    new_attr_value
+  end
+end
+
+def attr_accessor_with_class(expected_class, *attr_symbols)
+  attr_accessor_with_handler(*attr_symbols) do |new_attr_value|
+    AttrWithClass.verify_class_or_subclass(expected_class, new_attr_value)
+    new_attr_value
+  end
+end
+
+# enforces that all inputs are Integer and >= 0
+# special case of attr_writer_with_handler / attr_accessor_with_handler
+
+def attr_writer_with_non_negative_integer(*attr_symbols)
+  attr_writer_with_handler(*attr_symbols) do |new_attr_value|
+    AttrWithClass.verify_non_negative_integer(new_attr_value)
+    new_attr_value
+  end
+end
+
+def attr_accessor_with_non_negative_integer(*attr_symbols)
+  attr_accessor_with_handler(*attr_symbols) do |new_attr_value|
+    AttrWithClass.verify_non_negative_integer(new_attr_value)
+    new_attr_value
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: attr_with_class
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bobby Pennington
+bindir: exe
+cert_chain: []
+date: 2026-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+email:
+- bobby.pennington@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_with_class.gemspec
+- bin/console
+- bin/setup
+- example.rb
+- lib/attr_with_class.rb
+- lib/attr_with_class/version.rb
+homepage: https://github.com/bpenn9/attr_with_class
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bpenn9/attr_with_class
+  source_code_uri: https://github.com/bpenn9/attr_with_class
+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.6.2
+specification_version: 4
+summary: A couple variations of attr_accessor which support typecheking and custom
+  setter handling
+test_files: []