0.0
No commit activity in last 3 years
No release in over 3 years
A simple, framework-agnostic implementation of the decorator pattern, inspired by Avdi Grimms exhibits in 'objects on rails'.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

 Project Readme

Exhibitionist

Super-lightweight decorators, as inspired by Avdi Grimms Objects on Rails.

Installation

Add this line to your application's Gemfile:

gem 'exhibitionist'

And then execute:

$ bundle

Or install it yourself as:

$ gem install exhibitionist

Usage

An Exhibit is just a subclass of SimpleDelegator, organized via the Exhibitionist module.

Create exhibits by subclassing ```Exhibitionist::Base``:

class StringExhibit < Exhibitionist::Base
  # this exhibit applies to objects that respond to :to_s
  applies_if {|object| object.responds_to?(:to_s) }
end

Here are some example exhibits.

class ShoutExhibit < StringExhibit
  def shout
    __getobj__.to_s.upcase
  end
end

class WhisperExhibit < StringExhibit
  def whisper
    "<whisper>#{__getobj__.to_s.downcase}</whisper>"
  end
end

class ExclaimExhibit < StringExhibit
  def exclaim
    "#{__getobj__.to_s}!"
  end
end

Another exhibit, that applies to nothing:

class NeverAppliedExhibit < Exhibitionist::Base
  applies_if { |object| false }

  def boom
    "#{__getobj__.to_s} shakalaka"
  end
end

Register all your exhibits with the Exhibitionist module:

Exhibitionist.register ShoutExhibit, WhisperExhibit, ExclaimExhibit, NeverAppliedExhibit

Now calling Exhibitionist.exhibit(obj) will get you your object, wrapped with applicable exhibits.

exhibit = Exhibitionist.exhibit "Hello, world"

exhibit.shout            #=> "HELLO, WORLD"
exhibit.whisper          #=> "<whisper>hello, world</whisper>"
exhibit.exclaim          #=> "Hello, world!"
exhibit.boom             #=> NoMethodError, as object is not wrapped by NeverAppliedExhibit

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