Giter VIP home page Giter VIP logo

hash_to_struct's Introduction

HashToStruct

Gem Version Ruby

It enables recursive conversion of a ruby Hash to a Struct-like object and back.

Stop thinking about symbols vs strings when accessing values in your hash. Simply call a method.

It is built on top of standard Struct and OpenStruct classes with all their features preserved while adding a few on top for conveniences like handling nested hashes/arrays, unified constructor interface, immutability.

Installation

Add this line to your application's Gemfile:

gem 'hash_to_struct'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install hash_to_struct

Usage

Struct based conversion:

struct = HashToStruct.struct({q: 1})

struct.q # => 1
struct[:x] # => NameError: no member 'x' in struct

OpenStruct based conversion:

ostruct = HashToStruct.ostruct({q: 1})

ostruct.q # => 1
ostruct[:x] = 5
ostruct.x # => 5

Convert back to Hash:

ostruct.to_h # => { :q => 1, :x => 5 }

Recursive conversion:

struct = HashToStruct.struct({q: 1, w: { e: 2 }})

struct.q.w.e # => 2

Note! It will only convert objects of type Hash, not Hash derivatives or some acting like a Hash.

Recursive conversions inside Array:

struct = HashToStruct.struct({q: 1, w: [{ e: 2 }]}, including_arrays: true)

struct.q.w.first.e # => 2

Note! It will only iterate over objects of type Array, not Array derivatives or other enumerables.

Make immutable:

struct = HashToStruct.struct({q: 1}, immutable: true)

struct.q = 2 # => FrozenError: can't modify frozen #<struct q=1>

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/a-bohush/hash_to_struct.

License

The gem is available as open source under the terms of the MIT License.

hash_to_struct's People

Contributors

a-bohush avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.