https://github.com/nov/attr_required

Provide attr_required with presence validation
https://github.com/nov/attr_required

Keywords from Contributors

rack jose json-web-encryption json-web-key json-web-signature json-web-token jwe jwk jws oauth

Last synced: about 9 hours ago
JSON representation

Repository metadata

Provide attr_required with presence validation

• Host: GitHub
• URL: https://github.com/nov/attr_required
• Owner: nov
• License: mit
• Created: 2010-12-03T18:54:52.000Z (about 15 years ago)
• Default Branch: main
• Last Pushed: 2025-08-09T01:44:05.000Z (4 months ago)
• Last Synced: 2025-12-01T13:41:53.505Z (11 days ago)
• Language: Ruby
• Homepage:
• Size: 38.1 KB
• Stars: 8
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Releases: 0
• Metadata Files:
  • Readme: README.rdoc
  • Funding: .github/FUNDING.yml
  • License: LICENSE

README.rdoc

          = attr_required

This gem provide attr_required and attr_optional like attr_accessor.

REQUIRED and OPTIONAL are common terminology in RFCs, and used for protocol parameters.
This gem helps RFC library developers to define which parameters (attributes in Ruby world) are REQUIRED and which are OPTIONAL.
It might be also helpful for other developers.

I've developed this gem to use for rack-oauth2, a Rack-based OAuth 2.0 library.
https://github.com/nov/rack-oauth2

== Installation

  gem install attr_required

== Usage

# Attributes Definitions

  require 'attr_required'
  require 'attr_optional'

  class A
    include AttrRequired, AttrOptional
    attr_required :required_a
    attr_optional :optional_a
  end

  class B < A
    attr_required :required_b
    attr_optional :optional_b
  end

# Class Methods

  A.required_attributes #=> [:required_a]
  B.required_attributes #=> [:required_a, :required_b]
  A.optional_attributes #=> [:optional_a]
  B.optional_attributes #=> [:optional_a, :optional_b]

  A.attr_required?(:required_a) #=> true
  B.attr_optional?(:optional_b) #=> true

# Instance Methods

  @a = A.new
  @b = B.new

  @a.required_attributes #=> [:required_a]
  @b.required_attributes #=> [:required_a, :required_b]
  @a.optional_attributes #=> [:optional_a]
  @b.optional_attributes #=> [:optional_a, :optional_b]

  @a.attr_required?(:required_a) #=> true
  @a.attr_optional?(:optiona_a)  #=> true

  @a.attr_missing? #=> true
  @a.attr_missing  #=> [:required_a]
  @a.attr_missing! #=> raise AttrRequired::AttrMissing
  @a.required_a = "foo"
  @a.attr_missing? #=> false
  @a.attr_missing  #=> []
  @a.attr_missing! #=> do nothing

Check spec/attr_(required|optional).rb for more details.

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2010 nov matake. See LICENSE for details.

        

---

Owner metadata

• Name: Nov Matake
• Login: nov
• Email: nov@matake.jp
• Kind: user
• Description: Working around Ruby, OAuth, OpenID etc.
• Website: https://matake.jp
• Location: Tokyo, Japan
• Twitter: nov
• Company: YAuth.jp LLC
• Icon url: https://avatars.githubusercontent.com/u/27299?u=d02b1d3e03dc134d2d0a42e670eac1be099064e0&v=4
• Repositories: 166
• Last ynced at: 2025-10-29T22:36:11.404Z
• Profile URL: https://github.com/nov

---

GitHub Events

Total

Last Year

---

Committers metadata

Last synced: 7 days ago

Name	Email	Commits
nov matake	n****v@m****p	55
nov	n****e@g****t	6
Travis Illig	t****g@p****m	1
David Celis	me@d****s	1
Akira Matsuda	r****e@d****p	1

Committer domains:

• dio.jp: 1
• davidcel.is: 1
• paraesthesia.com: 1
• gree.net: 1
• matake.jp: 1

---

Issue and Pull Request metadata

Last synced: 3 months ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/nov/attr_required

---

---

---

Package metadata

• Total packages: 2
• Total downloads:
  • rubygems: 150,653,228 total
• Total docker downloads: 1,027,867,156
• Total dependent packages: 14 (may contain duplicates)
• Total dependent repositories: 3,209 (may contain duplicates)
• Total versions: 16
• Total maintainers: 1

---

Dependencies

Score: 24.576408175484342