schmetterling 0.0.1

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michał Łomnicki
+
+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,48 @@
+# Schmetterling
+
+Simple aspects implemented on Module#prepend.
+
+## Requirements
+
+Ruby 2.0
+
+## Highlights
+
+* Support before/after/around advices
+* Separate cross-cutting concerns
+
+## How it works
+
+Every time you add an advice a new anonymous module is created
+and prepended to the adviced class.
+
+The similar effect can be achived with alias method chaining.
+
+## Usage
+
+    class User
+      def recommend_book(book)
+        @recommended_books << book
+      end
+    end
+
+    class Twitter
+      def publish(token, message)
+        # ...
+      end
+    end
+
+    require 'schmetterling/dsl'
+    class AppConfiguration
+      include Schmetterling::DSL
+
+      def initialize(twitter)
+        @twitter = twitter
+      end
+
+      def enable
+        After(User, :recommend_book) do |user, book|
+          twitter.publish(user.twitter_token, "Hey, I just read #{book.title}")
+        end
+      end
+    end

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+end
+
+task :default => :test

data/lib/schmetterling.rb

@@ -0,0 +1,7 @@
+require "schemetterling/version"
+require "schemetterling/before"
+require "schemetterling/after"
+require "schemetterling/around"
+
+module Schmetterling
+end

data/lib/schmetterling/after.rb

@@ -0,0 +1,19 @@
+module Schmetterling
+  class After
+
+    def initialize(klass, method, advice=nil, &block)
+      advice ||= block
+      klass.send(:prepend, build_module_for_advice(method, advice))
+    end
+
+    def build_module_for_advice(adviced_method, advice)
+      Module.new do
+        define_method adviced_method do |*args|
+          super(*args)
+          advice.call(self, *args)
+        end
+      end
+    end
+
+  end
+end

data/lib/schmetterling/around.rb

@@ -0,0 +1,19 @@
+module Schmetterling
+  class Around
+
+    def initialize(klass, method, advice=nil, &block)
+      advice ||= block
+      klass.send(:prepend, build_module_for_advice(method, advice))
+    end
+
+    def build_module_for_advice(adviced_method, advice)
+      Module.new do
+        define_method adviced_method do |*args|
+          original_method = ->(args_for_original=args) { super(args_for_original) }
+          advice.call(original_method, self, *args)
+        end
+      end
+    end
+
+  end
+end

data/lib/schmetterling/before.rb

@@ -0,0 +1,19 @@
+module Schmetterling
+  class Before
+
+    def initialize(klass, method, advice=nil, &block)
+      advice ||= block
+      klass.send(:prepend, build_module_for_advice(method, advice))
+    end
+
+    def build_module_for_advice(adviced_method, advice)
+      Module.new do
+        define_method adviced_method do |*args|
+          advice.call(self, *args)
+          super(*args)
+        end
+      end
+    end
+
+  end
+end

data/lib/schmetterling/dsl.rb

@@ -0,0 +1,21 @@
+require 'schmetterling/before'
+require 'schmetterling/after'
+require 'schmetterling/around'
+
+module Schmetterling
+  module DSL
+
+    def Before(*args, &block)
+      Schmetterling::Before.new(*args, &block)
+    end
+
+    def After(*args, &block)
+      Schmetterling::After.new(*args, &block)
+    end
+
+    def Around(*args, &block)
+      Schmetterling::Around.new(*args, &block)
+    end
+
+  end
+end

data/lib/schmetterling/version.rb

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

data/schmetterling.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schmetterling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schmetterling"
+  spec.version       = Schmetterling::VERSION
+  spec.authors       = ["Michał Łomnicki"]
+  spec.email         = ["michal.lomnicki@gmail.com"]
+  spec.description   = %q{Aspects implemented on Ruby2.0 Class#prepend}
+  spec.summary       = %q{Aspects implemented on Ruby2.0 Class#prepend}
+  spec.homepage      = "https://github.com/x8/schmetterling"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.13"
+end

data/test/after_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+require 'schmetterling/after'
+
+class AfterTest < Test::Unit::TestCase
+
+  def setup
+    @adviced_class = Class.new do
+      def bar(calls)
+        calls << :method_called
+      end
+    end
+    @calls = []
+  end
+
+  def test_executes_the_advice_after_adviced_method
+    Schmetterling::After.new(@adviced_class, :bar, -> (object, calls) { calls << :after_called })
+    @adviced_class.new.bar(@calls)
+    assert_equal [:method_called, :after_called], @calls
+  end
+
+  def test_executes_multiple_advices
+    Schmetterling::After.new(@adviced_class, :bar, -> (object, calls) { calls << :after1_called })
+    Schmetterling::After.new(@adviced_class, :bar, -> (object, calls) { calls << :after2_called })
+    @adviced_class.new.bar(@calls)
+    assert_equal [:method_called, :after1_called, :after2_called], @calls
+  end
+
+  def test_works_on_child_classes
+    @child_class = Class.new(@adviced_class)
+    Schmetterling::After.new(@adviced_class, :bar, -> (object, calls) { calls << :after_called })
+    @child_class.new.bar(@calls)
+    assert_equal [:method_called, :after_called], @calls
+  end
+
+  def test_works_with_blocks
+    Schmetterling::After.new(@adviced_class, :bar) do |object, calls|
+      calls << :after_called
+    end
+    @adviced_class.new.bar(@calls)
+    assert_equal [:method_called, :after_called], @calls
+  end
+
+  def test_advice_receives_the_adviced_object
+    @adviced_object = @adviced_class.new
+    Schmetterling::After.new(@adviced_class, :bar) do |object, calls|
+      assert_equal @adviced_object, object
+      calls << :after_called
+    end
+    @adviced_object.bar(@calls)
+    assert_equal [:method_called, :after_called], @calls
+  end
+
+end

data/test/around_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+require 'schmetterling/around'
+
+class AroundTest < Test::Unit::TestCase
+
+  def setup
+    @calls = []
+    @adviced_class = Class.new do
+      def bar(calls)
+        calls << :method_called
+      end
+    end
+  end
+
+  def test_executes_the_advice_around_the_adviced_method
+    advice = -> (original_method, object, calls) {
+      calls << :before_called
+      original_method.call(calls)
+      calls << :after_called
+    }
+    Schmetterling::Around.new(@adviced_class, :bar, advice)
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before_called, :method_called, :after_called], @calls
+  end
+
+  def test_works_with_blocks
+    Schmetterling::Around.new(@adviced_class, :bar) do |original_method, object, calls|
+      calls << :before_called
+      original_method.call(calls)
+      calls << :after_called
+    end
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before_called, :method_called, :after_called], @calls
+  end
+
+  def test_changing_arguments
+    @changed_argument = []
+    advice = -> (original_method, object, calls) {
+      calls << :before_called
+      original_method.call(@changed_argument)
+      calls << :after_called
+    }
+    Schmetterling::Around.new(@adviced_class, :bar, advice)
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before_called, :after_called], @calls
+    assert_equal [:method_called], @changed_argument
+  end
+
+  def test_skipping_original_method
+    advice = -> (original_method, object, calls) {
+      calls << :evil_called
+    }
+    Schmetterling::Around.new(@adviced_class, :bar, advice)
+    @adviced_class.new.bar(@calls)
+    assert_equal [:evil_called], @calls
+  end
+
+  def test_advice_receives_the_adviced_object
+    @adviced_object = @adviced_class.new
+    Schmetterling::Around.new(@adviced_class, :bar) do |original_method, object, calls|
+      assert_equal @adviced_object, object
+      original_method.call(calls)
+    end
+    @adviced_object.bar(@calls)
+    assert_equal [:method_called], @calls
+  end
+
+end

data/test/before_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+require 'schmetterling/before'
+require 'schmetterling/after'
+
+class BeforeTest < Test::Unit::TestCase
+
+  def setup
+    @calls = []
+    @adviced_class = Class.new do
+      def bar(calls)
+        calls << :method_called
+      end
+    end
+  end
+
+  def test_executes_the_advice_before_adviced_method
+    Schmetterling::Before.new(@adviced_class, :bar, -> (object, calls) { calls << :before_called })
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before_called, :method_called], @calls
+  end
+
+  def test_executes_multiple_advices
+    Schmetterling::Before.new(@adviced_class, :bar, -> (object, calls) { calls << :before1_called })
+    Schmetterling::Before.new(@adviced_class, :bar, -> (object, calls) { calls << :before2_called })
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before2_called, :before1_called, :method_called], @calls
+  end
+
+  def test_works_on_child_classes
+    @child_class = Class.new(@adviced_class)
+    Schmetterling::Before.new(@adviced_class, :bar, -> (object, calls) { calls << :before_called })
+    @child_class.new.bar(@calls)
+    assert_equal [:before_called, :method_called], @calls
+  end
+
+  def test_works_with_blocks
+    Schmetterling::After.new(@adviced_class, :bar) do |object, calls|
+      calls << :after_called
+    end
+    @adviced_class.new.bar(@calls)
+    assert_equal [:method_called, :after_called], @calls
+  end
+
+  def test_is_always_called_before_the_after_aspects
+    Schmetterling::After.new(@adviced_class, :bar, -> (_, calls) { calls << :after1_called })
+    Schmetterling::Before.new(@adviced_class, :bar, -> (_, calls) { calls << :before1_called })
+    Schmetterling::After.new(@adviced_class, :bar, -> (_, calls) { calls << :after2_called })
+    Schmetterling::Before.new(@adviced_class, :bar, -> (_, calls) { calls << :before2_called })
+    @adviced_class.new.bar(@calls)
+    assert_equal [:before2_called, :before1_called, :method_called, :after1_called, :after2_called], @calls
+  end
+
+  def test_advice_receives_the_adviced_object
+    @adviced_object = @adviced_class.new
+    Schmetterling::Before.new(@adviced_class, :bar) do |object, calls|
+      assert_equal @adviced_object, object
+      calls << :before_called
+    end
+    @adviced_object.bar(@calls)
+    assert_equal [:before_called, :method_called], @calls
+  end
+
+end

data/test/dsl_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'schmetterling/dsl'
+
+class DslTest < Test::Unit::TestCase
+
+  class User
+    def foo; end
+  end
+
+  class Configuration
+    include Schmetterling::DSL
+
+    def initialize(twitter)
+      @twitter = twitter
+    end
+
+    def enable
+      After(User, :foo) do |user|
+        @twitter.publish(user, "some text")
+      end
+    end
+  end
+
+  def setup
+    @twitter = mock("Twitter")
+    @configuration = Configuration.new(@twitter)
+    @configuration.enable
+  end
+
+  def test_invokes_the_advice
+    @user = User.new
+    @twitter.expects(:publish).with(@user, "some text")
+    @user.foo
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'test/unit'
+require 'mocha/setup'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: schmetterling
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Michał Łomnicki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  name: mocha
+description: Aspects implemented on Ruby2.0 Class#prepend
+email:
+- michal.lomnicki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schmetterling.rb
+- lib/schmetterling/after.rb
+- lib/schmetterling/around.rb
+- lib/schmetterling/before.rb
+- lib/schmetterling/dsl.rb
+- lib/schmetterling/version.rb
+- schmetterling.gemspec
+- test/after_test.rb
+- test/around_test.rb
+- test/before_test.rb
+- test/dsl_test.rb
+- test/test_helper.rb
+homepage: https://github.com/x8/schmetterling
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Aspects implemented on Ruby2.0 Class#prepend
+test_files:
+- test/after_test.rb
+- test/around_test.rb
+- test/before_test.rb
+- test/dsl_test.rb
+- test/test_helper.rb