records gem / library - frozen / immutable structs with copy on updates
- home :: github.com/s6ruby/records
- bugs :: github.com/s6ruby/records/issues
- gem :: rubygems.org/gems/records
- rdoc :: rubydoc.info/gems/records
Use Record.new like Struct.new to build / create a new frozen / immutable
record class. Example:
Record.new( :Account,
balance: Integer,
allowances: Hash )
# -or-
Record.new :Account,
balance: Integer,
allowances: Hash
# -or-
Record.new :Account, { balance: Integer,
allowances: Hash }
# -or-
class Account < Record::Base
field :balance, Integer
field :allowances, Hash
endAnd use the new record class like:
account = Account.new( 1, {} )
account.frozen? #=> true
account.values.frozen? #=> true
account.balance #=> 1
account.allowances #=> {}
account.values #=> [1, {}]
Account.keys #=> [:balance, :allowances]
Account.fields #=> [<Field @key=:balance, @index=0, @type=Integer>,
# <Field @key=:allowances, @index=1, @type=Hash>]
Account.index( :balance ) #=> 0
Account.index( :allowances ) #=> 1Note: The update method (or the << alias)
ALWAYS returns a new record.
account.update( balance: 20 ) #=> [20, {}]
account.update( balance: 30 ) #=> [30, {}]
account.update( { balance: 30 } ) #=> [30, {}]
account << { balance: 20 } #=> [20, {}]
account << { balance: 30 } #=> [30, {}]
account = account.update( balance: 40, allowances: { 'Alice': 20 } )
account.balance #=> 40
account.allowances #=> { 'Alice': 20 }
account.values #=> [40, { 'Alice': 20 } ]
# ...And so on and so forth.
Using the Record Update Pragma. Lets you
account {... balance: 20 } #=> [20, {}]
account {... balance: 30 } #=> [30, {}]
account = {... balance: 40, allowances: { 'Alice': 20 }}turn into:
account.update( balance: 20 ) #=> [20, {}]
account.update( balance: 30 ) #=> [30, {}]
account = account.update( balance: 40, allowances: { 'Alice': 20 } )See Language Syntax Pragmas - Let's Evolve Ruby by Experimenting in a Pragma(tic) Way » for more.
The records scripts are dedicated to the public domain.
Use it as you please with no restrictions whatsoever.
Send them along to the wwwmake forum. Thanks!