aspekt 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,123 @@
+Usage
+=====
+
+
+Methods you should be using
+---------------------------
+
+Although *Aspekt* consists of 4 classes and 2 modules, you should be using directly only 3 methods which API will never change:
+
+  * #before   (Aspekt::Helpers::ShorthandMethods#before)
+  * #after    (Aspekt::Helpers::ShorthandMethods#after)
+  * #around   (Aspekt::Helpers::ShorthandMethods#around)
+
+```ruby
+before|after|around ([instance(s)|type(s): Symbol|Regexp|Object|Array<Symbol|Regexp|Object>],) method(s): Symbol|Regexp|Array<Symbol|Regexp> do |joinpoint|
+  # what to do ...
+  # in case of around, `joinpoint.proceed` has to be called
+end
+```
+
+* If instance or type is not specified, type: self is assumed.
+* If you want, you can overwrite them and use them in your application as you want... Or you just create around advice for them and change arguments order as you like.
+
+
+Example #1: In class body
+-------------------------
+```ruby
+class Example
+  def one; end
+  def two; end
+  def self.three; end
+  def self.four; end
+
+  before method: :one do 
+    puts "before method one"
+  end
+  
+  after({type: self, methods: [:one, :two]}, {instance: self, method: :three}) do |joinpoint|
+    puts "method #{joinpoint[:method]} was called on #{self} with arguments #{joinpoint[:args]}"
+  end 
+
+  around instance: self, method: /thr/ do |joinpoint|
+    puts "Before around #{joinpoint}"
+    result = joinpoint.proceed           # calling orginal method
+    puts "After around #{joinpoint}"
+    result                               # return orginal value
+  end
+
+  class<<self
+    before method: :four do 
+      puts "before four"
+    end
+  end
+
+end
+```
+
+
+Example #2: In random place
+---------------------------
+```ruby
+before types: [/Strin/, /Arra/], instances: [some_object, :SomeClassForSingletonMethods], methods: [/^beginning_with/, :to_mushroom] do |joinpoint|
+  puts joinpoint
+end
+```
+
+
+Example #3: In aspects
+----------------------
+
+### Recommended 
+
+1. Create folder called 'aspects' in your load path.
+2. Create Aspect for Concern:
+
+```ruby
+# ./aspects/logging/exceptions.rb (parent folder of 'aspects' must be in load path):
+module Aspects
+  module Logging
+    module Exceptions
+
+      after type: Exception, method: :initialize do |joinpoint|
+        MyLogger.log "Just threw exception #{self.class}: #{self.backtrace}"
+      end
+
+    end
+  end
+end
+```
+
+
+### You could also
+
+* Create your own logic, but you should take care, that aspects are loaded.
+
+
+
+Installation
+============
+
+
+Using Bundler
+-------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'aspekt'
+```
+
+And run:
+
+```bash
+bundle install
+```
+
+
+Using gem
+---------
+
+```bash
+gem install aspekt
+```

data/Rakefile

@@ -0,0 +1,38 @@
+# documentation
+namespace 'doc' do
+  task :generate do
+    puts `rm -rf ./doc`
+    puts `yard doc --exclude 'test' --exclude 'Rakefile' --exclude 'Gemfile'`
+  end  
+end
+
+# vc
+namespace 'vc' do
+  task :commit do
+    puts `git add -A`
+    puts `git commit -a --message="#{ENV['message']}"` 
+    puts `git push origin development`
+  end
+end
+
+# gem
+namespace 'gem' do
+  task :build do
+    puts `gem build aspekt.gemspec`
+  end  
+  task :push do
+    puts `gem push aspekt*.gem`
+  end
+  task :remove_build do
+    puts `rm -rf aspekt*.gem`
+  end
+  task :publish => [:build, :push, :remove_build]
+end
+
+# tests
+namespace 'tests' do
+  task :run do
+    puts `rspec --color --tty`
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspekt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: is_same
-  requirement: &13075360 !ruby/object:Gem::Requirement
+  requirement: &23847920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13075360
+  version_requirements: *23847920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &13074900 !ruby/object:Gem::Requirement
+  requirement: &23847460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13074900
+  version_requirements: *23847460
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &13074480 !ruby/object:Gem::Requirement
+  requirement: &23847040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13074480
+  version_requirements: *23847040
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &13074060 !ruby/object:Gem::Requirement
+  requirement: &23846620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13074060
+  version_requirements: *23846620
 - !ruby/object:Gem::Dependency
   name: yard-rdoc
-  requirement: &13073640 !ruby/object:Gem::Requirement
+  requirement: &23846200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,14 +65,16 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13073640
+  version_requirements: *23846200
 description: Before, after and around method calls. Supports Regexp matching.
 email: margus@tione.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - Gemfile
+- Rakefile
 - lib/aspekt.rb
 - lib/aspekt/object.rb
 - lib/aspekt/helpers/shorthand_methods.rb