Giter VIP home page Giter VIP logo

nashie's Introduction

Nashie

Nashie takes the Hashie concept one step further and allows you to create nested structure with buildin validation logic.

Nashies are used in the wild as presenters for API responses and to validate incoming API calls.

Installation

Add this line to your application's Gemfile:

gem 'nashie'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nashie

Usage

class Part < Hashie::Nash
   property :name, :required => true
end

class Engine < Hashie::Nash
  property :build_year, :required => true
  property :nitro, :default => false
  property :parts, :collection => true, :class => "Part"
end

class Car < Hashie::Nash
  property :engine, :required => true, :class => Engine
end

car = Car.new "engine" => {"build_year" => 2010, "nitro" => false, :parts => [{"name" => "crankshaft"}, {"name" => "flywheel"}]}

Overrides

Overriding the initialization method allows you to inject some custom logic if needed.

class Motorcycle
  def initialize hash
    raise "Euhm, a motorcycle has 2 wheels you know..." if not hash[:wheels].eql? 2
    super hash
  end
end

DSL

A DSL is provided for inline declaration.

class Presentation < Hashie::Nash
  property :users, :collection => true, :required => true do
     property :name
  end
end

Future work

  • more types of validations
  • Customizable error messages

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

nashie's People

Contributors

noverloop avatar carvil 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.