Coder Social home page Coder Social logo

hasho's Introduction

Hash-o

Hash-o (pronounced Hash-Oh!) is a Ruby gem that provides a simple way for creating the #to_h methods in objects. The #to_h is a standard interface added in Ruby 2.0 and it should return a hash representation of an object.

Installation

Add this line to your application's Gemfile:

gem 'hasho'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hasho

Usage

Let's use a simple example to ilustrate the usage of hash-o:

class User
  include Hasho

  def name
    "John Smith"
  end

  def email
    "[email protected]"
  end
end

user = User.new
user.to_h

# => { name: "John Smith", email: "[email protected]" }

Hash-o works out of the box because, if no options are specified, it will reflect on the object's public interface and generate the hash based on it.

If for any reason you don't want to include all the object's public interface, you can specify which attributes will be included in the hash:

class User
  include Hasho
  
  hash_methods :name, :email

  def name
    "John Smith"
  end

  def email
    "[email protected]"
  end
  
  def password
    "superSecretOMG!"
  end
end

user = User.new
user.to_h

# => { name: "John Smith", email: "[email protected]" }

This is pretty much it, simple but effective.

Todo

  • Add an :except option to method call so user can tell which attributes shouldn't be added.
  • Accept attributes (other than those already on the method interface) and add them as keys/values to the hash.
  • Accept an attribute with an associated Proc and use result as the value on the hash.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/hasho/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

hasho's People

Contributors

dreoliv avatar

Watchers

 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.