surround 0.0.1

data/History.md

@@ -0,0 +1,5 @@
+
+0.0.1 / 2012-02-14 
+==================
+
+  * 1st.

data/Manifest

@@ -0,0 +1,9 @@
+History.md
+Manifest
+Rakefile
+Readme.md
+lib/surround.rb
+lib/surround/base.rb
+spec/spec_helper.rb
+spec/surround/base_spec.rb
+spec/surround_spec.rb

data/Rakefile

@@ -0,0 +1,21 @@
+#--
+# Surround.
+#
+# Veselin Todorov <hi@vesln.com>
+# MIT License.
+#++
+
+require 'rspec/core/rake_task'
+require 'rake'
+require 'echoe'
+
+Echoe.new('surround', '0.0.1') do |p|
+  p.description    = "Surround a method, save a polar bear."
+  p.url            = "http://github.com/vesln/surround.rb"
+  p.author         = "Veselin Todorov"
+  p.email          = "hi@vesln.com"
+  p.ignore_pattern = ["tmp/*"]
+  p.development_dependencies = ['rspec', 'rake']
+end
+
+RSpec::Core::RakeTask.new('spec')

data/Readme.md

@@ -0,0 +1,66 @@
+# Surround.rb
+
+Surround.rb port of my surround module for Node.js. The gem provides an easy way to surround a method with before and after functionality.
+
+## Synopsis
+
+```ruby
+
+class SuperHero
+  include Surround::Base
+
+  def magic(param)
+    # Do magic here.
+  end
+end
+
+SuperHero.surround :magic, :before do |param|
+  # Win!
+end
+
+hero = SuperHero.new
+hero.magic('foo')
+
+SuperHero.restore(:magic) # Clears added surrounders
+
+SuperHero.surrounded?(:magic) # Is it surrounded?
+
+```
+
+## Install
+
+Gemfile:
+
+```ruby
+gem 'surround'
+```
+
+or 
+
+```
+gem install surround
+````
+
+## License
+
+MIT License
+
+Copyright (C) 2012 Veselin Todorov
+
+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/lib/surround.rb

@@ -0,0 +1,12 @@
+#--
+# Surround.
+#
+# Veselin Todorov <hi@vesln.com>
+# MIT License.
+#++
+
+module Surround
+  VERSION = '0.0.1'
+
+  autoload :Base, 'surround/base'
+end

data/lib/surround/base.rb

@@ -0,0 +1,53 @@
+#--
+# Surround.
+#
+# Veselin Todorov <hi@vesln.com>
+# MIT License.
+#++
+
+module Surround
+  module Base
+    def self.included(base)
+      base.extend self
+    end
+
+    def surround(method, position, &block)
+      surround_method(method, position, &block) unless surrounded?(method)
+      register_surrounder(method, position, &block)
+    end
+
+    def surrounders(method)
+      @__surround[method] if @__surround.has_key?(method)
+    end
+
+    def surrounded?(method)
+      !@__surround.nil? && @__surround.has_key?(method)
+    end
+
+    def restore(method)
+      return false unless (surrounded? method)
+      @__surround.delete(method)
+      alias_method method, "original_#{method}"
+    end
+
+    private
+
+    def register_surrounder(method, position, &block)
+      @__surround[method][position].push block
+    end
+
+    def surround_method(method, position, &block)
+      @__surround = {} if @__surround.nil?
+      @__surround[method] = {:before => [], :after => []}
+
+      alias_method "original_#{method}", method unless self.respond_to?("original_#{method}")
+
+      define_method method do |*args|
+        surrounders = self.class.surrounders(method)
+        surrounders[:before].each { |b| b.call(*args) }
+        self.send("original_#{method}", *args)
+        surrounders[:after].each { |b| b.call(*args) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+#--
+# Surround.
+#
+# Veselin Todorov <hi@vesln.com>
+# MIT License.
+#++
+
+require 'surround'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/surround/base_spec.rb

@@ -0,0 +1,91 @@
+#--
+# Surround.
+#
+# Veselin Todorov <hi@vesln.com>
+# MIT License.
+#++
+
+require 'spec_helper'
+
+class Dummy
+  include Surround::Base
+  attr_accessor :called
+  attr_accessor :result
+
+  def foo
+    @called = true
+  end
+
+  def bar(foo)
+    @result = foo
+  end
+end
+
+describe 'Surround::Base' do
+  before(:each) do
+    @dummy = Dummy.new
+  end
+
+  after(:each) do
+    Dummy.restore(:foo)
+    Dummy.restore(:bar)
+  end
+
+  describe 'surround' do
+    context 'before' do
+      it 'should add and call before surrounder' do
+        once = false
+        twice = false
+        Dummy.surround :foo, :before do
+          once = true
+        end
+        Dummy.surround :foo, :before do
+          twice = true
+        end
+        @dummy.foo
+        once.should === true
+        twice.should === true
+        @dummy.called.should === true
+      end
+    end
+    context 'after' do
+      it 'should add and call after surrounder' do
+        called = false
+        Dummy.surround :foo, :after do
+          called = true
+        end
+        @dummy.foo
+        called.should === true
+        @dummy.called.should === true
+      end
+    end
+
+    it 'should pass arguments to blocks and to the original method' do
+      result = nil
+      Dummy.surround :bar, :before do |r|
+        result = r
+      end
+      @dummy.bar('foo')
+      result.should === 'foo'
+      @dummy.result.should === 'foo'
+    end
+  end
+
+  describe 'surrounded?' do
+    it 'should the sorrund state for a method' do
+      Dummy.surrounded?(:foo).should === false
+      Dummy.surround :foo, :after do
+      end
+      Dummy.surrounded?(:foo).should === true
+    end
+  end
+
+  describe 'restore' do
+    it 'should restore surrounded method' do
+      Dummy.surround :foo, :after do
+      end
+      Dummy.restore(:foo)
+      Dummy.surrounded?(:foo).should === false
+    end
+  end
+end

data/spec/surround_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Surround do
+  it 'should have sane version' do
+    Surround::VERSION.should match /\d\.\d.\d/
+  end
+end

data/surround.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "surround"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Veselin Todorov"]
+  s.date = "2012-02-14"
+  s.description = "Surround a method, save a polar bear."
+  s.email = "hi@vesln.com"
+  s.extra_rdoc_files = ["lib/surround.rb", "lib/surround/base.rb"]
+  s.files = ["History.md", "Manifest", "Rakefile", "Readme.md", "lib/surround.rb", "lib/surround/base.rb", "spec/spec_helper.rb", "spec/surround/base_spec.rb", "spec/surround_spec.rb", "surround.gemspec"]
+  s.homepage = "http://github.com/vesln/surround.rb"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Surround", "--main", "Readme.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "surround"
+  s.rubygems_version = "1.8.15"
+  s.summary = "Surround a method, save a polar bear."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: surround
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Veselin Todorov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70335963005800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335963005800
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70335963005340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335963005340
+description: Surround a method, save a polar bear.
+email: hi@vesln.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- lib/surround.rb
+- lib/surround/base.rb
+files:
+- History.md
+- Manifest
+- Rakefile
+- Readme.md
+- lib/surround.rb
+- lib/surround/base.rb
+- spec/spec_helper.rb
+- spec/surround/base_spec.rb
+- spec/surround_spec.rb
+- surround.gemspec
+homepage: http://github.com/vesln/surround.rb
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Surround
+- --main
+- Readme.md
+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: '1.2'
+requirements: []
+rubyforge_project: surround
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Surround a method, save a polar bear.
+test_files: []