basic_decorator 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joshua Clayton
+
+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,127 @@
+# BasicDecorator
+
+Decoration in Ruby should be easy. With `BasicDecorator`, it is.
+
+`BasicDecorator` was spawned by my [Gist](https://gist.github.com/1523849) in
+response to [this post on the thoughtbot
+blog](http://robots.thoughtbot.com/post/14825364877/evaluating-alternative-decorator-implementations-in).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'basic_decorator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basic_decorator
+
+## Usage
+
+Decorators are a wonderful design pattern allowing a developer to modify,
+extend, or otherwise change the behavior of an object while maintaining its
+interface. Remember ActiveSupport's `alias_method_chain`? That was essentially
+an inline (bastardized) decoration that mutated the object. If you want to
+read about the Decorator pattern, I suggest you check out:
+
+* [C&C Wiki](http://c2.com/cgi/wiki?DecoratorPattern)
+* [Wikipedia](http://en.wikipedia.org/wiki/Decorator_pattern)
+
+Knowing about decorators, where does `BasicDecorator` fall? How do you use it?
+
+Your decorators inherit from `BasicDecorator::Decorator` and you'll have
+access to the instance variable `@component`, the object passed in to the
+decorator's constructor.
+
+Let's start off with the common 'Coffee', 'Cream', and 'Sugar' example. Here's
+our first object, `Coffee`.
+
+```ruby
+class Coffee
+  def cost
+    Money.new(250, 'USD')
+  end
+
+  def origin
+    'Columbia'
+  end
+
+  def additional_ingredients
+    []
+  end
+end
+```
+
+Fairly straightforward. Let's write up decorators for `Cream` and `Sugar`.
+
+```ruby
+class Cream < BasicDecorator::Decorator
+  def cost
+    @component.cost + ::Money.new(75, 'USD')
+  end
+
+  def additional_ingredients
+    @component.additional_ingredients + ['Cream']
+  end
+end
+
+class Sugar < BasicDecorator::Decorator
+  def cost
+    @component.cost + ::Money.new(25, 'USD')
+  end
+
+  def additional_ingredients
+    @component.additional_ingredients + ['Sugar']
+  end
+end
+```
+
+If a method isn't defined on the decorator, it gets delegated to the
+`@component` (via `method_missing`), meaning it'll keep your decorators nice
+and thin; only define the methods of whom you want to change the behavior.
+
+`Sugar` and `Cream` may decorate `Coffee` any number of times.
+
+```ruby
+coffee = Coffee.new
+# #<Coffee:0x007fb78a8c5ae8>
+tasty_coffee = Sugar.new(Cream.new(coffee))
+# #<Coffee:0x007fb78a8c5ae8>
+
+coffee.cost
+# #<Money cents:250 currency:USD>
+tasty_coffee.cost
+# #<Money cents:350 currency:USD>
+
+coffee.additional_ingredients
+# []
+tasty_coffee.additional_ingredients
+# ["Cream", "Sugar"]
+
+tasty_coffee.is_a? Coffee
+# true
+```
+
+You may want to be careful of decorating objects like arrays. Decoration
+typically won't mutate the component you're decorating; again, just something
+to be aware of.
+
+## 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
+
+## Author
+
+Written 2012 by Josh Clayton
+
+## License
+
+Check the LICENSE

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/basic_decorator.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/basic_decorator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Josh Clayton']
+  gem.email         = ['joshua.clayton@gmail.com']
+  gem.description   = %q{Decoration in Ruby should be easy}
+  gem.summary       = %q{Decoration in Ruby should be easy. With BasicDecorator, it is.}
+  gem.homepage      = 'https://github.com/joshuaclayton/basic_decorator'
+
+  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          = 'basic_decorator'
+  gem.require_paths = ['lib']
+  gem.version       = BasicDecorator::VERSION
+
+  gem.add_development_dependency('rspec', '~> 2.0')
+  gem.add_development_dependency('money', '~> 5.0')
+end

data/lib/basic_decorator.rb

@@ -0,0 +1,5 @@
+require 'basic_decorator/version'
+require 'basic_decorator/decorator'
+
+module BasicDecorator
+end

data/lib/basic_decorator/decorator.rb

@@ -0,0 +1,17 @@
+module BasicDecorator
+  class Decorator < BasicObject
+    undef_method :==
+
+    def initialize(component)
+      @component = component
+    end
+
+    def method_missing(name, *args, &block)
+      @component.send(name, *args, &block)
+    end
+
+    def send(symbol, *args)
+      __send__(symbol, *args)
+    end
+  end
+end

data/lib/basic_decorator/version.rb

@@ -0,0 +1,3 @@
+module BasicDecorator
+  VERSION = "0.1.0"
+end

data/spec/lib/basic_decorator/decorator_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'money'
+
+describe BasicDecorator::Decorator do
+  before do
+    class Coffee
+      def cost
+        Money.new(250, 'USD')
+      end
+
+      def origin
+        'Columbia'
+      end
+
+      def additional_ingredients
+        []
+      end
+    end
+
+    class Cream < BasicDecorator::Decorator
+      def cost
+        @component.cost + ::Money.new(75, 'USD')
+      end
+
+      def additional_ingredients
+        @component.additional_ingredients + ['Cream']
+      end
+    end
+
+    class Sugar < BasicDecorator::Decorator
+      def cost
+        @component.cost + ::Money.new(25, 'USD')
+      end
+
+      def additional_ingredients
+        @component.additional_ingredients + ['Sugar']
+      end
+    end
+  end
+
+  let(:coffee) { Coffee.new }
+
+  shared_examples_for 'Coffee' do
+    context 'maintaining the object' do
+      it { should == coffee }
+      it { should be_an_instance_of(Coffee) }
+
+      its(:object_id) { should == coffee.object_id }
+      its(:class) { should == coffee.class }
+    end
+
+    context 'maintaining interface' do
+      it { should respond_to(:cost) }
+      it { should respond_to(:origin) }
+      it { should respond_to(:additional_ingredients) }
+    end
+  end
+
+  describe 'Coffee' do
+    subject { coffee }
+
+    it_behaves_like 'Coffee'
+
+    its(:cost) { should == 2.5 }
+    its(:origin) { should == 'Columbia' }
+    its(:additional_ingredients) { should be_empty }
+  end
+
+  describe 'Coffee with Sugar' do
+    subject { Sugar.new(coffee) }
+
+    it_behaves_like 'Coffee'
+
+    its(:cost) { should == 2.75 }
+    its(:origin) { should == 'Columbia' }
+    its(:additional_ingredients) { should == ['Sugar'] }
+  end
+
+  describe 'Coffee with two Sugar' do
+    subject { Sugar.new(Sugar.new(coffee)) }
+
+    it_behaves_like 'Coffee'
+
+    its(:cost) { should == 3.0 }
+    its(:origin) { should == 'Columbia' }
+    its(:additional_ingredients) { should == ['Sugar', 'Sugar'] }
+  end
+
+  describe 'Coffee with Cream and Sugar' do
+    subject { Sugar.new(Cream.new(coffee)) }
+
+    it_behaves_like 'Coffee'
+
+    its(:cost) { should == 3.5 }
+    its(:origin) { should == 'Columbia' }
+    its(:additional_ingredients) { should == ['Cream', 'Sugar'] }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rspec'
+
+require 'basic_decorator'
+
+Dir['spec/support/**/*.rb'].each {|f| require File.expand_path(f) }

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: basic_decorator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Clayton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Decoration in Ruby should be easy
+email:
+- joshua.clayton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- basic_decorator.gemspec
+- lib/basic_decorator.rb
+- lib/basic_decorator/decorator.rb
+- lib/basic_decorator/version.rb
+- spec/lib/basic_decorator/decorator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joshuaclayton/basic_decorator
+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.23
+signing_key: 
+specification_version: 3
+summary: Decoration in Ruby should be easy. With BasicDecorator, it is.
+test_files:
+- spec/lib/basic_decorator/decorator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: