dress_up 1.0.0a

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Morgan Brown
+
+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,89 @@
+# Dress Up [![Build Status](https://secure.travis-ci.org/mhgbrown/dress_up.png)](http://travis-ci.org/mhgbrown/dress_up)
+Let's play dress-up! Dress Up allows you to specify named sets of method overrides that you can selectively enable and disable.
+
+## Compatibility
+Dress Up relies on the Ruby 1.9.X ordering of Hash entries.
+
+## Example
+Below is the Duck class that has defined two costumes: dog and robosoldier.  The dog costume overrides the ```name=``` method to append "Dog" and the ```speak``` method to return "Woof!".  The robosoldier costume overrides ```speak``` as well and adds a new method, ```terminations```.
+
+	class Duck
+		# include the Dress Up functionality
+		include DressUp::Interface
+
+		attr_accessor :name, :age
+
+		# define a dog costume
+		costume :dog, :name= => lambda {|name| @name = name + " Dog"}, :speak => "Woof!"
+		# define a robosoldier costume
+		costume :robosoldier, :speak => lambda {"I will terminate you! " + super()}, :terminations => 23
+
+		def initialize(name, age)
+			@name, @age = name, age
+		end
+
+		def speak
+			"Quack!"
+		end
+	end
+
+When the dog costume is applied, it overrides the methods it specifies:
+
+	duck = Duck.new("Horace", 2)
+	duck.put_on(:dog)
+	duck.name = "George"
+	puts duck.name
+	=> "George Dog"
+	puts duck.speak
+	=> "Woof!"
+
+When the robosoldier costume is applied, its overrides are merged with dog's overrides and reapplied.
+
+	duck.put_on(:robosoldier)
+	puts duck.speak
+	=> "I will terminate you! Quack!"
+	puts duck.terminations
+	=> 23
+
+When the dog and robosoldier costumes are removed, their overrides are removed.
+
+	duck.take_off(:dog)
+	duck.name = "T1000"
+	puts duck.name
+	=> "T1000"
+	duck.take_off(:robosoldier)
+	puts duck.speak
+	=> "Quack!"
+	puts duck.terminations
+	=> NoMethodError
+
+All the costumes can be applied at once:
+
+	duck.dress_up
+	duck.name = "Bob"
+	puts duck.name
+	=> "Bob Dog"
+	puts duck.terminations
+	=> 23
+
+They can also all be removed at once:
+
+	duck.dress_down
+	puts duck.speak
+	=> "Quack!"
+
+Access all of Duck's costumes:
+
+	Duck.closet
+	=> {:dog => <DressUp::Costume ... >, ...}
+
+Access a duck's current outfit:
+
+	duck.put_on(:dog)
+	duck.outfit
+	=> <DressUp::Outfit ... >
+
+## Future Considerations
+ * Instead of merging overrides, just define overrides in sequence
+
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dress_up.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dress_up/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dress_up"
+  s.version     = DressUp::VERSION
+  s.authors     = ["Morgan Brown"]
+  s.email       = ["brown.mhg@gmail.com"]
+  s.homepage    = "https://github.com/discom4rt/dress_up"
+  s.summary     = "Enable and disable sets of method overrides"
+  s.description = "Dress Up allows you to specify named sets of method overrides that you can selectively enable and disable."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/lib/dress_up/costume.rb

@@ -0,0 +1,27 @@
+module DressUp
+  # Costume represents a named set of method overrides.
+  class Costume
+
+    attr_reader :name, :overrides
+
+    # Create a new costume with the given name and overrides.  Overrides are
+    # converted into lambdas if necessary.
+    def initialize(name, overrides={})
+      @name = name
+      @overrides = overrides.inject({}) do |hash, (method_name, value)|
+        unless value.respond_to? :call
+          hash[method_name] = lambda { value }
+        else
+          hash[method_name] = value
+        end
+        hash
+      end
+    end
+
+    # Retreive an override by its identifier
+    def [](override)
+      @overrides[override]
+    end
+
+  end
+end

data/lib/dress_up/errors.rb

@@ -0,0 +1,16 @@
+module DressUp
+  # Errors holds DressUp specific errors.
+  module Errors
+
+    # UndefinedCostumeError is raised when an operation
+    # is performed with a costume that has not been defined.
+    class UndefinedCostumeError < StandardError
+
+      # The default error message highlights the absence
+      # of the costume
+      def initialize(costume)
+        super("#{costume} has not been defined")
+      end
+    end
+  end
+end

data/lib/dress_up/interface.rb

@@ -0,0 +1,84 @@
+module DressUp
+  # The Interface module provides the methods to
+  # define, put on, and take off costumes.
+  module Interface
+    def self.included(base)
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      # When extedended, define closet reader
+      def self.extended(base)
+        class << base
+          attr_reader :closet
+        end
+        base.instance_variable_set("@closet", {})
+      end
+
+      # Define a costume by giving it a name and a set of overrides
+      def costume(name, overrides={})
+        unless name.is_a?(Symbol) || name.is_a?(String)
+          raise "#{name.inspect} is not a valid costume name"
+        end
+
+        @closet ||= {}
+        if overrides.empty?
+          @closet[name]
+        else
+          @closet[name] = DressUp::Costume.new(name, overrides)
+        end
+      end
+    end
+
+    module InstanceMethods
+      # When included, define the outfit reader
+      def self.included(base)
+        base.class_eval do
+          attr_reader :outfit
+        end
+      end
+
+      # Apply the costume with the given name to this object and
+      # set up and outfit if necessary.  If the  costume does not exist,
+      # an error is raised.
+      def put_on(costume_name)
+        costume = self.class.closet[costume_name]
+        if costume
+          @outfit ||= DressUp::Outfit.new(self)
+          @outfit.apply(costume)
+          costume
+        else
+          raise DressUp::Errors::UndefinedCostumeError, costume_name
+        end
+      end
+
+      # Apply all the costumes defined for this object's class.  Set up an
+      # oufit if necessary.
+      def dress_up
+        @outfit ||= DressUp::Outfit.new(self)
+        @outfit.apply(*self.class.closet.values)
+      end
+
+      # Remove the costume with the given name from this object and clear an
+      # existing outfit if necessary.  If the costume does not exist, an
+      # error is raised.
+      def take_off(costume_name)
+        costume = self.class.closet[costume_name]
+        if costume
+          @outfit && @outfit.remove(costume)
+          @outfit = nil if @outfit && @outfit.empty?
+        else
+          raise DressUp::Errors::UndefinedCostumeError, costume_name
+        end
+      end
+
+      # Remove all the costumes defined for this object's class.  Clear an
+      # existing outfit if necessary.
+      def dress_down
+        @outfit && @outfit.remove(*self.class.closet.values)
+        @outfit = nil if @outfit && @outfit.empty?
+      end
+    end
+  end
+end

data/lib/dress_up/outfit.rb

@@ -0,0 +1,82 @@
+module DressUp
+  # Outfit represents a set of costumes in use by a given object.
+  class Outfit
+
+    attr_reader :costumes, :getup, :object
+
+    # Create a new outfit with the given object.  Method overrides
+    # provided by costumes associated with this outfit will
+    # be applied to this object.
+    def initialize(object)
+      @costumes = {}
+      @getup = {}
+      @object = object
+    end
+
+    # Apply the given costumes to this outfit's object. Costume overrides
+    # are applied in the order that costumes are put on.
+    def apply(*other_costumes)
+      change_getup do
+        other_costumes.each do |costume|
+          @costumes[costume.name] = costume.overrides
+        end
+      end
+    end
+
+    # Remove the given costumes from this outfit's object.
+    def remove(*other_costumes)
+      change_getup do
+        other_costumes.each do |costume|
+          @costumes.delete(costume.name)
+        end
+      end
+    end
+
+    # Determine if this outfit has no costumes.
+    def empty?
+      @costumes.empty?
+    end
+
+    private
+
+    # Change the getup of this outfit safely by removing
+    # all of the overrides, rebuilding the getup and finally
+    # reapplying the overrides. Takes a block in which it is assumed
+    # changes to the costumes will be made.
+    def change_getup(&block)
+      peel_down
+      yield if block_given?
+      rebuild
+      suit_up
+    end
+
+    # Rebuild the final getup from all the active costumes.
+    def rebuild
+      @getup = @costumes.inject({}) do |hash, (name, overrides)|
+        hash.merge!(overrides)
+      end
+    end
+
+    # Apply the getup (overrides) to the object.
+    def suit_up
+      @getup.each do |method_name, callable|
+        @object.define_singleton_method(method_name, &callable)
+      end
+    end
+
+    # Remove the overrides from the object.
+    def peel_down
+      @getup.each do |method_name, _|
+        remove_singleton_method(method_name)
+      end
+    end
+
+    # Remove a singleton method from the object.  Does not completely
+    # undefine the method from the context.
+    def remove_singleton_method(name)
+      metaclass = @object.instance_eval "class << self; self; end"
+      metaclass.send(:remove_method, name)
+    end
+
+  end
+end

data/lib/dress_up/version.rb

@@ -0,0 +1,3 @@
+module DressUp
+  VERSION = "1.0.0a"
+end

data/lib/dress_up.rb

@@ -0,0 +1,8 @@
+require "dress_up/version"
+require "dress_up/interface"
+require "dress_up/costume"
+require "dress_up/outfit"
+require "dress_up/errors"
+
+module DressUp
+end

data/spec/dress_up/dress_up_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+describe DressUp do
+
+  before(:each) do
+    class Duck
+      include DressUp::Interface
+
+      attr_accessor :name, :age
+
+      def initialize(name, age)
+        @name, @age = name, age
+      end
+
+      def speak
+        "Quack!"
+      end
+    end
+  end
+
+  after(:each) do
+    Object.send(:remove_const, :Duck)
+  end
+
+  let(:duck) { Duck.new("Horace", 5) }
+
+  it "should provide a method to declare a costume" do
+    Duck.respond_to?(:costume).should == true
+  end
+
+  it "should raise an error if a costume is declared without a name" do
+    lambda { Duck.costume(:speak => "Woof!") }.should raise_error
+  end
+
+  describe "when some costumes have been declared" do
+    before(:each) do
+      Duck.costume(:dog, :speak => "Woof!", :name= => lambda {|value| @name = value + " Dog"})
+      Duck.costume(:robosoldier, :speak => "You will be terminated!", :kills => 57)
+    end
+
+    it "there should be a way to get the declared costumes individually" do
+      dog_costume = Duck.costume(:dog)
+      dog_costume.class.should == DressUp::Costume
+      dog_costume.name.should == :dog
+      dog_costume.overrides[:speak].call.should == "Woof!"
+      dog_costume.overrides[:name=].call("Joe").should == "Joe Dog"
+    end
+
+    it "there should be a way to get all the costumes" do
+      Duck.closet.length.should == 2
+      Duck.closet[:dog].class.should == DressUp::Costume
+      Duck.closet[:robosoldier].class.should == DressUp::Costume
+    end
+
+    it "should provide a method to put on a costume, which will override the specified costume methods to return the specified values" do
+      duck.put_on(:dog)
+      duck.speak.should == "Woof!"
+      duck.name = "Fluffy"
+      duck.name.should == "Fluffy Dog"
+    end
+
+    it "should return a costume when your put on a costume" do
+      duck.put_on(:dog).class.should == DressUp::Costume
+    end
+
+    it "should provide raise an error when you try to put on a costume that doesn't exist" do
+      lambda { duck.put_on(:cow) }.should raise_error(DressUp::Errors::UndefinedCostumeError)
+    end
+
+    it "should provide a way to take off a costume" do
+      duck.put_on(:dog)
+      duck.take_off(:dog)
+      duck.speak.should == "Quack!"
+    end
+
+    it "should return nothing if you try to take off a costume that is not on" do
+      duck.take_off(:dog).should == nil
+    end
+
+    it "should raise an error if you try to take off a costume that does not exist" do
+      lambda { duck.take_off(:cow) }.should raise_error(DressUp::Errors::UndefinedCostumeError)
+    end
+
+    it "should create a method supplied by the costume when it does not exist on the target object" do
+      Duck.costume(:robosoldier, :kills => 57)
+      duck.put_on(:robosoldier)
+      duck.kills.should == 57
+    end
+
+    it "should replace an old costume with a new costume of the same name" do
+      Duck.costume(:dog, :speak => "Bark!")
+      duck.take_off(:dog)
+      duck.put_on(:dog)
+      duck.speak.should == "Bark!"
+      duck.name = "Jeffrey"
+      duck.name.should == "Jeffrey"
+    end
+
+    describe "when a costume is already on" do
+      before(:each) do
+        duck.put_on(:dog)
+      end
+
+      # or should this somehow merge the return values?
+      it "any new costume that is put on should override the current costume's return values where they overlap" do
+        duck.put_on(:robosoldier)
+        duck.speak.should == "You will be terminated!"
+        duck.name = "T2600"
+        duck.name.should == "T2600 Dog"
+        duck.kills.should == 57
+      end
+
+      it "and then when the costume is taken off, the object's method should return what they originally did" do
+        duck.put_on(:robosoldier)
+        duck.take_off(:robosoldier)
+        duck.speak.should == "Woof!"
+        duck.respond_to?(:kills).should == false
+      end
+
+      it "should provide a way to access all the costumes that are on (an outfit)" do
+        duck.outfit.class.should == DressUp::Outfit
+        duck.outfit.costumes[:dog][:name=].should == Duck.closet[:dog][:name=]
+        duck.outfit.costumes[:dog][:speak].should == Duck.closet[:dog][:speak]
+      end
+    end
+
+    it "should return nil if you try to get an outfit with no costumes on" do
+      duck.outfit.should == nil
+    end
+
+    it "should provde a way to put on all the costumes" do
+      duck.dress_up
+      duck.speak.should == "You will be terminated!"
+      duck.name = "George"
+      duck.name.should == "George Dog"
+      duck.kills.should == 57
+    end
+
+    it "should provide a way to take off all costumes" do
+      duck.dress_up
+      duck.dress_down
+      duck.speak.should == "Quack!"
+      duck.name = "Daffy"
+      duck.name.should == "Daffy"
+      duck.respond_to?(:kills).should == false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'dress_up'
+
+RSpec.configure do |config|
+  # nothing
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: dress_up
+version: !ruby/object:Gem::Version 
+  hash: 58
+  prerelease: 5
+  segments: 
+  - 1
+  - 0
+  - 0
+  - a
+  version: 1.0.0a
+platform: ruby
+authors: 
+- Morgan Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Dress Up allows you to specify named sets of method overrides that you can selectively enable and disable.
+email: 
+- brown.mhg@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- dress_up.gemspec
+- lib/dress_up.rb
+- lib/dress_up/costume.rb
+- lib/dress_up/errors.rb
+- lib/dress_up/interface.rb
+- lib/dress_up/outfit.rb
+- lib/dress_up/version.rb
+- spec/dress_up/dress_up_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/discom4rt/dress_up
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Enable and disable sets of method overrides
+test_files: 
+- spec/dress_up/dress_up_spec.rb
+- spec/spec_helper.rb