- Notifications
You must be signed in to change notification settings - Fork0
ImmutableStructEx is yet another immutable struct. What makes ImmutableStructEx different, is that it allows you to create immutable structs in one step by default. In other words, other immutable struct gems force you to first define the struct, then instantiate the struct object; or, define the struct and instantiate the struct object via chai…
License
gangelo/immutable_struct_ex
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
immutable_struct_ex is yet another immutable struct. What makes immutable_struct_ex different, is that it allows you to create immutable structs in one stepby default. In other words, other immutable struct gems force you to first define the struct, then instantiate the struct object; or, define the struct and instantiate the struct object via chaining. For example:
# How OTHER immutable structs declare and instantiate, two steps...some_immutable_struct=SomeImmutableStruct.new(:first,:last,:phone)some_immutable_struct.new(first:'John',last:'Doe',phone:'(201) 230-7281')# How OTHER immutable structs chain...some_immutable_struct=SomeImmutableStruct.new(:first,:last,:phone).new(first:'John',last:'Doe',phone:'(201) 230-7281')
immutable_struct_ex allows you to instantiate and initialize the objectin one step:
immutable_struct_ex=ImmutableStructEx.new(first:'John',last:'Doe',phone:'(201) 230-7281')immutable_struct_ex.first#=> 'John'immutable_struct_ex[:first]#=> 'John'immutable_struct_ex.last#=> 'Doe'immutable_struct_ex.phone#=> '(201) 230-7281'
Like other immutable structs, immutable_struct_ex also removes methods that change the state of the object, making itimmutable:
immutable_struct_ex.first='Joe'#=> NoMethodError: undefined method `first='...immutable_struct_ex[:first]='Joe'#=> NoMethodError: undefined method `[]='...
Also, not unlike other immutable structs, immutable_struct_ex also allows you to pass a block:
# With a blockimmutable_struct_ex=ImmutableStructEx.new(first:'John',last:'Doe',phone:'(201) 230-7281')dodefjohn?first =='John'endendimmutable_struct_ex.john?#=> true
Get creative. Below is an example of an immutable struct that providesredaction:
# Redactable, immutable structuser={username:'jdoe',password:'p@55w0rD',ssn:'123-70-9182'}immutable_struct_ex=ImmutableStructEx.new(**user)doREDACT=%i(passwordssn).freezedefinspectto_senddefto_ssuper.to_s.tapdo |string|REDACT.eachdo |redact|string.gsub!(/(#{Regexp.quote(redact.to_s)}=")(.*?)(")/,'\1[REDACTED]\3')endendenddefto_hsuper.to_h.tapdo |hash|REDACT.each{ |redact|hash[redact]='[REDACTED]'}endendendimmutable_struct_ex.inspect#=> "#<struct username=\"jdoe\", password=\"[REDACTED]\", ssn=\"[REDACTED]\">"immutable_struct_ex.to_h#=> {:username=>"jdoe", :password=>"[REDACTED]", :ssn=>"[REDACTED]"}
Add this line to your application's Gemfile:
gem'immutable_struct_ex'
And then execute:
$ bundleOr install it yourself as:
$ gem install immutable_struct_exAfter checking out the repo, runbin/setup to install dependencies. Then, runrake spec to run the tests. You can also runbin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, runbundle exec rake install. To release a new version, update the version number inversion.rb, and then runbundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the.gem file torubygems.org.
Bug reports and pull requests are welcome on GitHub athttps://github.com/[USERNAME]/immutable_struct_ex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to theContributor Covenant code of conduct.
The gem is available as open source under the terms of theMIT License.
Everyone interacting in the ImmutableStructEx project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow thecode of conduct.
About
ImmutableStructEx is yet another immutable struct. What makes ImmutableStructEx different, is that it allows you to create immutable structs in one step by default. In other words, other immutable struct gems force you to first define the struct, then instantiate the struct object; or, define the struct and instantiate the struct object via chai…
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.