ruby_decorators 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+# Ruby Decorators
+
+#### Ruby method decorators inspired by Python.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_decorators'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_decorators
+
+## Usage
+
+```ruby
+class Batman < RubyDecorator
+  def call(this)
+    this.sub('world', 'batman')
+  end
+end
+
+class Catwoman < RubyDecorator
+  def initialize(*args)
+    @args = args.any? ? args : ['catwoman']
+  end
+
+  def call(this)
+    this.sub('world', @args.join(' '))
+  end
+end
+
+class DummyClass
+  extend RubyDecorators
+
+  def initialize
+    @greeting = 'hello world'
+  end
+
+  def hello_world
+    @greeting
+  end
+
+  +Batman
+  def hello_batman
+    @greeting
+  end
+
+  +Catwoman
+  def hello_catwoman
+    @greeting
+  end
+
+  +Catwoman.new('super', 'catwoman')
+  def hello_super_catwoman
+    @greeting
+  end
+end
+
+dummy = DummyClass.new
+
+dummy.hello_world # => "hello world"
+dummy.hello_batman # => "hello batman"
+dummy.hello_catwoman # => "hello catwoman"
+dummy.hello_super_catwoman # => "hello super catwoman"
+```
+
+## License
+
+Copyright (c) 2012 [Fred Wu](http://fredwu.me/)
+
+Licensed under the [MIT license](http://fredwu.mit-license.org/).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/ruby_decorator.rb

@@ -0,0 +1,9 @@
+class RubyDecorator
+  def self.+@
+    RubyDecorators::Stack.decorators << self
+  end
+
+  def +@
+    RubyDecorators::Stack.decorators << self
+  end
+end

data/lib/ruby_decorators/stack.rb

@@ -0,0 +1,7 @@
+module RubyDecorators
+  class Stack
+    def self.decorators
+      @decorators ||= []
+    end
+  end
+end

data/lib/ruby_decorators/version.rb

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

data/lib/ruby_decorators.rb

@@ -0,0 +1,49 @@
+require "ruby_decorators/version"
+require "ruby_decorator"
+require "ruby_decorators/stack"
+
+module RubyDecorators
+  def method_added(method_name)
+    @decorated_methods ||= []
+
+    return if RubyDecorators::Stack.decorators.empty?  ||
+              method_name.to_s =~ /__undecorated_/     ||
+              @decorated_methods.include?(method_name)
+
+    current_decorator = RubyDecorators::Stack.decorators.pop
+    method_visibility = detect_method_visibility(method_name)
+
+    class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+      alias_method :__undecorated_#{method_name}, :#{method_name}
+
+      @__decorators ||= {}
+      @__decorators["#{method_name}"] = current_decorator
+
+      #{method_visibility}
+      def #{method_name}(*args, &blk)
+        decorator = #{current_decorator}.new
+        decorator ||= self.class.instance_variable_get(:@__decorators)["#{method_name}"]
+
+        if args.any?
+          decorator.call(self.send :__undecorated_#{method_name}, *args, &blk)
+        else
+          decorator.call(self.send :__undecorated_#{method_name}, &blk)
+        end
+      end
+    RUBY_EVAL
+
+    @decorated_methods << method_name
+  end
+
+  private
+
+  def detect_method_visibility(method_name)
+    if private_method_defined?(method_name)
+      :private
+    elsif protected_method_defined?(method_name)
+      :protected
+    else
+      :public
+    end
+  end
+end

data/ruby_decorators.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_decorators/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby_decorators"
+  gem.version       = RubyDecorators::VERSION
+  gem.authors       = ["Fred Wu"]
+  gem.email         = ["ifredwu@gmail.com"]
+  gem.description   = %q{Ruby method decorators inspired by Python.}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'minitest'
+end

data/spec/ruby_decorators_spec.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RubyDecorators do
+  class DummyDecorator < RubyDecorator
+    def call(this)
+      'I should never be called'
+    end
+  end
+
+  class Batman < RubyDecorator
+    def call(this)
+      this.sub('world', 'batman')
+    end
+  end
+
+  class Catwoman < RubyDecorator
+    def initialize(*args)
+      @args = args.any? ? args : ['catwoman']
+    end
+
+    def call(this)
+      this.sub('world', @args.join(' '))
+    end
+  end
+
+  class DummyClass
+    extend RubyDecorators
+
+    def initialize
+      @greeting = 'hello world'
+    end
+
+    def hello_world
+      @greeting
+    end
+
+    +Batman
+    def hello_public
+      @greeting
+    end
+
+    +DummyDecorator
+    def hello_void
+      @greeting
+    end
+
+    +Batman
+    def hello_with_args(arg1, arg2)
+      "#{@greeting} #{arg1} #{arg2}"
+    end
+
+    +Catwoman
+    def hello_catwoman
+      @greeting
+    end
+
+    +Batman
+    def hello_with_block(arg1, arg2, &block)
+      "#{@greeting} #{arg1} #{arg2} #{block.call if block_given?}"
+    end
+
+    +Catwoman.new('super', 'catwoman')
+    def hello_super_catwoman
+      @greeting
+    end
+
+    protected
+
+    +Batman
+    def hello_protected
+      @greeting
+    end
+
+    private
+
+    +Batman
+    def hello_private
+      @greeting
+    end
+  end
+
+  subject { DummyClass.new }
+
+  it "#hello_world" do
+    subject.hello_world.must_equal 'hello world'
+  end
+
+  describe "a simple decorator" do
+    it "decorates a public method" do
+      subject.hello_public.must_equal 'hello batman'
+    end
+
+    it "decorates a protected method" do
+      subject.send(:hello_protected).must_equal 'hello batman'
+      lambda { subject.hello_protected }.must_raise NoMethodError
+    end
+
+    it "decorates a private method" do
+      subject.send(:hello_private).must_equal 'hello batman'
+      lambda { subject.hello_private }.must_raise NoMethodError
+    end
+
+    it "decorates a method with args" do
+      subject.hello_with_args('how are', 'you?').must_equal 'hello batman how are you?'
+    end
+
+    it "decorates a method with a block" do
+      subject.hello_with_block('how are', 'you') { 'man?' }.must_equal 'hello batman how are you man?'
+    end
+  end
+
+  describe "a decorator with args" do
+    it "decorates without any decorator args" do
+      subject.hello_catwoman.must_equal 'hello catwoman'
+    end
+
+    it "decorate a simple method" do
+      subject.hello_super_catwoman.must_equal 'hello super catwoman'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'pry'
+
+require File.expand_path('../../lib/ruby_decorators', __FILE__)

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ruby_decorators
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fred Wu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Ruby method decorators inspired by Python.
+email:
+- ifredwu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/ruby_decorator.rb
+- lib/ruby_decorators.rb
+- lib/ruby_decorators/stack.rb
+- lib/ruby_decorators/version.rb
+- ruby_decorators.gemspec
+- spec/ruby_decorators_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -334699568952873457
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -334699568952873457
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby method decorators inspired by Python.
+test_files:
+- spec/ruby_decorators_spec.rb
+- spec/spec_helper.rb