exhibitionist 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exhibitionist.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Najaf Ali
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+
+# Exhibitionist
+
+Super-lightweight decorators, as inspired by Avdi Grimms [Objects on Rails](http://objectsonrails.com/).
+
+## 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``:
+
+```ruby
+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.
+
+```ruby
+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:
+
+```ruby
+class NeverAppliedExhibit < Exhibitionist::Base
+  applies_if { |object| false }
+
+  def boom
+    "#{__getobj__.to_s} shakalaka"
+  end
+end
+```
+
+Register all your exhibits with the ```Exhibitionist``` module:
+
+```ruby
+Exhibitionist.register ShoutExhibit, WhisperExhibit, ExclaimExhibit, NeverAppliedExhibit
+```
+
+Now calling ```Exhibitionist.exhibit(obj)``` will get you your object, wrapped with applicable exhibits.
+
+```ruby
+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
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.libs.push 'spec'
+  t.libs.push 'spec/support'
+end
+
+task :spec => :test

data/exhibitionist.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/exhibitionist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Najaf Ali"]
+  gem.email         = ["ali.najaf@gmail.com"]
+  gem.description   = %q{A simple, framework-agnostic implementation of the decorator pattern, inspired by Avdi Grimms exhibits in 'objects on rails'.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/Najaf/exhibitionist"
+
+  %w( minitest-reporters ).each do |dep|
+    gem.add_development_dependency  dep
+  end
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "exhibitionist"
+  gem.require_paths = ["lib"]
+  gem.version       = Exhibitionist::VERSION
+end

data/lib/exhibitionist.rb

@@ -0,0 +1,32 @@
+require "exhibitionist/version"
+require 'exhibitionist/base'
+
+module Exhibitionist
+  @@exhibits = []
+
+  class << self
+    def exhibits
+      @@exhibits
+    end
+
+    def exhibits=(exhibits)
+      @@exhibits = exhibits
+    end
+
+    def register(*exhibits)
+      @@exhibits += exhibits
+      nil
+    end
+
+    #def register_dir(directory)
+      #raise Exhibitionist::Base.subclasses.inspect
+      #File.expand_path(directory)
+    #end
+
+    def exhibit(object)
+      @@exhibits.reduce object do |object, exhibit|
+        exhibit.exhibit_if_applicable(object)
+      end
+    end
+  end
+end

data/lib/exhibitionist/base.rb

@@ -0,0 +1,30 @@
+require 'delegate'
+module Exhibitionist
+  class Base < SimpleDelegator
+    def class
+      __getobj__.class
+    end
+
+    class << self
+      def applicable_to?(object)
+        if @condition
+          return @condition.yield(object)
+        else
+          false
+        end
+      end
+
+      def exhibit_if_applicable(object)
+        applicable_to?(object) ? self.new(object) : object
+      end
+
+      def applies_if(&block)
+        @condition = block
+      end
+
+      def applies_unless(&block)
+        @conditions = Proc.new { |object| !(block.yield(object)) }
+      end
+    end
+  end
+end

data/lib/exhibitionist/version.rb

@@ -0,0 +1,3 @@
+module Exhibitionist
+  VERSION = "0.0.1"
+end

data/spec/exhibitionist/base_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'test_exhibits/empty_exhibit'
+require 'test_exhibits/shout_exhibit'
+require 'test_exhibits/stutter_exhibit'
+
+describe Exhibitionist::Base do
+
+  class Speaker
+    def say(string)
+      string
+    end
+  end
+
+  let(:bare)           { Speaker.new }
+  let(:exhibit)        { ShoutExhibit.new(bare) }
+  let(:double_exhibit) { StutterExhibit.new(exhibit) }
+
+  it 'decorates methods' do
+    bare.say('woof').must_equal 'woof'
+    exhibit.say('woof').must_equal 'WOOF'
+  end
+
+  it 'allows multiple exhibits to wrap an object' do
+    double_exhibit.say('meow').must_equal 'Ummm... MEOW'
+  end
+
+  it '#class returns the class of the wrapped object' do
+    double_exhibit.class.must_equal Speaker
+  end
+
+  it 'responds to applicable_to?' do
+    StutterExhibit.must_respond_to :applicable_to?
+  end
+
+  it 'returns false for applicable_to? by default' do
+    EmptyExhibit.applicable_to?(Object.new).must_equal false
+  end
+
+  describe '.exhibit_if_applicable' do
+    it 'returns original object if not applicable' do
+      original = ShoutExhibit.exhibit_if_applicable(bare)
+      original.say('howl').must_equal 'howl'
+    end
+
+    it 'returns exhibited object if applicable' do
+      exhibited = StutterExhibit.exhibit_if_applicable(bare)
+      exhibited.say('growl').must_equal 'Ummm... growl'
+    end
+  end
+
+  describe '.applies_if' do
+    it 'can be called in definitions of subclasses of Exhibitionist::Base' do
+      class TestExhibit < Exhibitionist::Base
+        applies_if {}
+      end
+    end
+
+    it 'takes a lambda that is evaluated to determine whether it is applicable to a given object' do
+      class AnotherTestExhibit < Exhibitionist::Base
+        applies_if { |object| object.class == Speaker }
+      end
+      AnotherTestExhibit.applicable_to?(bare).must_equal true
+    end
+  end
+
+  describe '.applies_unless' do
+    it 'does the opposite of .applies_if' do
+      class YetAnotherTestExhibit < Exhibitionist::Base
+        applies_unless { |object| object.class == Speaker }
+      end
+      YetAnotherTestExhibit.applicable_to?(bare).must_equal false
+    end
+  end
+end

data/spec/exhibitionist_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'test_exhibits/shout_exhibit'
+require 'test_exhibits/stutter_exhibit'
+require 'test_exhibits/whisper_exhibit'
+
+describe Exhibitionist do
+
+  class Speaker
+    def say(string)
+      string
+    end
+  end
+
+  let(:speaker) { Speaker.new }
+
+  before do
+    Exhibitionist.exhibits = []
+  end
+
+  describe '.exhibits' do
+    it 'returns an empty array by default' do
+      Exhibitionist.exhibits.must_equal []
+    end 
+  end
+
+  describe '.register' do
+    it 'returns nil' do
+      Exhibitionist.register(Object.new).must_be_nil
+    end
+
+    it 'registers exhibit' do
+      Exhibitionist.register ShoutExhibit
+      Exhibitionist.exhibits.must_equal [ShoutExhibit]
+    end
+
+    it 'takes multiple exhibits' do
+      Exhibitionist.register ShoutExhibit, StutterExhibit
+      Exhibitionist.exhibits.must_equal [ShoutExhibit, StutterExhibit]
+    end
+  end
+
+  describe '.exhibit' do
+    it 'returns original object if there are no exhibits registered' do
+      Exhibitionist.exhibits.must_equal []
+      original = Exhibitionist.exhibit(speaker)
+      original.say('woof').must_equal('woof')
+    end
+
+    it 'wraps original object if applicable' do
+      Exhibitionist.register StutterExhibit
+      wrapped = Exhibitionist.exhibit(speaker)
+      wrapped.say('woof').must_equal('Ummm... woof')
+    end
+
+    it 'wraps multiple registered exhibits, if applicable' do
+      Exhibitionist.register ShoutExhibit, StutterExhibit, WhisperExhibit
+      wrapped = Exhibitionist.exhibit(speaker)
+      # we make no assumptions about order, so it could be either of the following
+      possible = ['<whisper>Ummm... meow</whisper>', 'Ummm... <whisper>meow</whisper>']
+      possible.must_include wrapped.say('meow')
+    end
+  end
+
+  #describe '.register_dir' do
+    #it 'registers all the exhibits in a directory' do
+      #Exhibitionist.register_dir 'test_exhibits'
+      #Exhibitionist.exhibits.must_equal [EmptyExhibit, ShoutExhibit, StutterExhibit, WhisperExhibit]
+    #end
+  #end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/reporters'
+
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new
+
+require 'exhibitionist'

data/spec/support/test_exhibits/empty_exhibit.rb

@@ -0,0 +1,2 @@
+class EmptyExhibit < Exhibitionist::Base
+end

data/spec/support/test_exhibits/shout_exhibit.rb

@@ -0,0 +1,9 @@
+class ShoutExhibit < Exhibitionist::Base
+  def say(string)
+    __getobj__.say(string).upcase
+  end
+  
+  def self.applicable_to?(object)
+    false
+  end
+end

data/spec/support/test_exhibits/stutter_exhibit.rb

@@ -0,0 +1,9 @@
+class StutterExhibit < Exhibitionist::Base
+  def say(string)
+    "Ummm... #{__getobj__.say(string)}"
+  end
+
+  def self.applicable_to?(object)
+    true
+  end
+end

data/spec/support/test_exhibits/whisper_exhibit.rb

@@ -0,0 +1,9 @@
+class WhisperExhibit < Exhibitionist::Base
+  def say(string)
+    "<whisper>#{__getobj__.say(string)}</whisper>"
+  end
+
+  def self.applicable_to?(object)
+    true
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: exhibitionist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Najaf Ali
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, framework-agnostic implementation of the decorator pattern,
+  inspired by Avdi Grimms exhibits in 'objects on rails'.
+email:
+- ali.najaf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exhibitionist.gemspec
+- lib/exhibitionist.rb
+- lib/exhibitionist/base.rb
+- lib/exhibitionist/version.rb
+- spec/exhibitionist/base_spec.rb
+- spec/exhibitionist_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_exhibits/empty_exhibit.rb
+- spec/support/test_exhibits/shout_exhibit.rb
+- spec/support/test_exhibits/stutter_exhibit.rb
+- spec/support/test_exhibits/whisper_exhibit.rb
+homepage: http://github.com/Najaf/exhibitionist
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A simple, framework-agnostic implementation of the decorator pattern, inspired
+  by Avdi Grimms exhibits in 'objects on rails'.
+test_files:
+- spec/exhibitionist/base_spec.rb
+- spec/exhibitionist_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_exhibits/empty_exhibit.rb
+- spec/support/test_exhibits/shout_exhibit.rb
+- spec/support/test_exhibits/stutter_exhibit.rb
+- spec/support/test_exhibits/whisper_exhibit.rb