Code Monkey home page Code Monkey logo

nullobject's Introduction

NullObject

Null Object Design Pattern Ruby implementation

travis-ci

Intent

The intent of a Null Object is to encapsulate the absence of an object by providing a substitutable alternative that offers suitable default do nothing behavior. In short, a design where “nothing will come of nothing”

More about Null Object Pattern you can find here:

See also the avdi/naught gem for extended variations of the null object pattern for Ruby 1.9.

Usage

# examples from http://avdi.org/devblog/2011/05/30/null-objects-and-falsiness/

Null::Object.instance.foobar.baz.buz

def Maybe(value)
  case value
  when nil then Null::Object.instance
  else value
  end
end

def slug(title)
  Maybe(title).strip.downcase.tr('^[0-9a-z]', '-')
end

h = {}

slug(h[:missing_key]) # => ""

foo = Null::Object.instance

foo.to_s # => ""
foo.to_a # => []
foo.to_i # => 0
foo.to_f # => 0.0
foo.nil? # => true

# Custom Null Object

class FooNullObject
  include Null

  def to_bar
    "nothing here"
  end
end

foo = FooNullObject.instance
foo.to_bar # => "nothing here"
foo.to_s   # => ""

Setup

If you are using bundler add nullobject to your Gemfile:

gem 'nullobject'

Then run:

bundle install

Otherwise install the gem:

gem install nullobject

and require it in your project:

require 'nullobject'

Development

Source hosted at GitHub. Report Issues/Feature requests on GitHub Issues.

Tests can be ran with rake test

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2012 Marcin Ciunelis. See LICENSE for details.

nullobject's People

Contributors

cgunther avatar guilhermesimoes avatar martinciu avatar nilbus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

nullobject's Issues

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.