aspector 0.13.1 → 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 875a24ec8871a619beaff9400d10a24882cc5341
+  data.tar.gz: 4f6309f8ad1ce4ee9899f5dcf581650c8e87a132
+SHA512:
+  metadata.gz: 4ddbbc122722076f9a27bc6e96f68ac83d75a1cd873f39c86c65fef0c5c448d29b638e0477330ed73e5714b920b44268df541d517350b382d9181ff09bd60dad
+  data.tar.gz: 1168aca86c936638963416f44e06834b0916242037634196483ee3fd37842feb7720e2ba68c85b5616c9926c9838c86271b7700c3c47f12c89017108d98bb0ae

data/.gitignore

@@ -0,0 +1,14 @@
+.idea
+performance-tests/output
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+.svn
+.DS_Store
+*.tmproj
+*.swp
+.redcar
+.rbx

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AlignParameters:
+  Enabled: false
+ClassLength:
+  CountComments: false
+  Max: 200
+LineLength:
+  Max: 99
+MethodLength:
+  CountComments: false
+  Max: 15
+Metrics/AbcSize:
+  Max: 25
+AllCops:
+  Exclude:
+    - bin/**/*
+    - /.gemspec/
+    - !ruby/regexp /old_and_unused\.rb$/
+    - lib/**/*
+  Include:
+    - Rakefile
+    - aspector.gemspec
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  SupportedStyles:
+    - aligned
+    - indented

data/.ruby-gemset

@@ -0,0 +1 @@
+aspector

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -1,13 +1,10 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
-  #- rbx-18mode
-  #- rbx-19mode
-# uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec spec
-#gemfile: Gemfile.travis
-
+  - 2.0.0
+  - 2.1.5
+  - 2.2.2
+script:
+  - bundle exec rubocop spec
+  - bundle exec rubocop examples
+  - bundle exec rubocop benchmarks
+  - bundle exec rspec spec

data/Changelog.md

@@ -0,0 +1,59 @@
+# Aspector
+
+## Changelog
+
+### 0.15.0
+
+* Created instance of an aspect can be applied to multiple targets(classes/instances)
+* aspect_arg replaced with interception_arg because of multiple possible targets with different options
+* aspect_arg no longer works - accessing aspect can be done via interception (interception.aspect)
+* Interception options inherit all the default aspect options + options per interception
+* Specs for interception_arg
+* Specs for accessing interception options
+* Specs that validate if interception options inherit aspect default options
+* Logger proc printing instead of evaluating fix
+
+### 0.14.0
+
+* jruby support drop - there's no 2.0 syntax for jruby yet. Once it's out of beta - no further work needs to be done (works for me on beta)
+* drop 1.8 and 1.9 - even ruby guys recommend upgrading
+* added rubocop for spec/, examples/ and benchmarks/
+* fixed examples issues (they were not working anymore)
+* fixed benchmarks (outdated libs, etc)
+* added examples execution to rspec - now rspec will notify if any example is not working. That way we will be able to provide code changes without having to worry that they will break examples
+* added way more specs (93% code coverage)
+* added rubocop to travis
+* some minor cleanups
+* moved from rvmrc (deprecated) to ruby-gemset and ruby-version
+* removed unused gems
+* added simplecov to track code coverage
+* updated syntax to match 2.2.2
+* moved versioning to Aspector::VERSION
+* gemspec cleanup
+* benchmarks now use RubyProf new version
+* benchmarks moved to /benchmarks
+* all the examples work again
+* lib/aspector load order rearrange
+* aspector advice rearrange - now it doesn't have to use integer values with constants
+* before_filter as a separate TYPE - that way we don't have to "if" anything - works out of the box easier
+* some method optimization or rewrites for many methods - works the same, looks way better
+* advices metadata cleanup - no need for mandatory_options anymore
+* API CHANGE: old_methods_only replaced with existing_methods_only - when I started to use aspector the "old" was hard to understand - existing is way more straightforward
+* base disabled? now returns either true or false (no nil since it might change)
+* boolean methods that return nil return now true/false
+* before advices are now picked from before and before_filter advices
+* METHOD_TEMPLATE update with new logger logic
+* METHOD_TEMPLATE indentations are now more readable
+* base_class_methods now generate all the bind methods automatically based on Aspector::Advice::TYPES
+* deferred options to_s cleanup
+* New logger that is based on Ruby default logger (::Logger) - same log levels, same API (except *args for our contextes)
+* Logger is now much smaller
+* Logging - constanize is now easier to read but the API stays the same (fallback as well)
+* Method matcher#to_s uses now the & syntax for inspect
+* ObjectExtension #returns removed - it was never used (throw was never used)
+* Spec helper cleanup
+* Rspec no longer needs monkey patching (config.disable_monkey_patching!)
+* Class building logic is now wrapped in a module instead of a single method - all the class "building" and "cloning" happens in one place
+* Added some pendings for future improvement
+* skip_if_false for a before that should act as before_filter removed (since before filter is now a separate aspect)
+* version dump

data/Gemfile

@@ -1,18 +1,13 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 group :development do
-  gem "rspec"
-  gem "jeweler", "~> 1.6.4"
-
-  gem 'ruby-prof', :platforms => [:mri]
-
-  gem "guard", "~> 0.8.4"
-  gem "guard-bundler", "~> 0.1.3"
-  gem "guard-rspec", "~> 0.5.2"
-  gem "guard-shell", "~> 0.1.1"
-  gem 'rb-fsevent'
-  gem 'growl', "~> 1.0.3"
-
-  gem 'awesome_print'
+  gem 'rspec'
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-shell'
+  gem 'rubocop'
   gem 'pry'
+  gem 'simplecov'
+  gem 'ruby-prof'
 end

data/Gemfile.lock

@@ -1,62 +1,96 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    awesome_print (1.1.0)
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    growl (1.0.3)
-    guard (0.8.8)
-      thor (~> 0.14.6)
-    guard-bundler (0.1.3)
-      bundler (>= 1.0.0)
-      guard (>= 0.2.2)
-    guard-rspec (0.5.11)
-      guard (>= 0.8.4)
-    guard-shell (0.1.1)
-      guard (>= 0.2.0)
-    jeweler (1.6.4)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.12.8)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
       bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    method_source (0.8.1)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-    pry (0.9.10-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-      spoon (~> 0.0)
-    rake (10.0.3)
-    rb-fsevent (0.9.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
-    ruby-prof (0.11.3)
-    slop (3.3.3)
-    spoon (0.0.1)
-    thor (0.14.6)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-shell (0.7.1)
+      guard (>= 2.0.0)
+      guard-compat (~> 1.0)
+    json (1.8.3)
+    listen (3.0.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.3.0.pre.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-prof (0.15.8)
+    ruby-progressbar (1.7.5)
+    shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
-  awesome_print
-  growl (~> 1.0.3)
-  guard (~> 0.8.4)
-  guard-bundler (~> 0.1.3)
-  guard-rspec (~> 0.5.2)
-  guard-shell (~> 0.1.1)
-  jeweler (~> 1.6.4)
+  guard
+  guard-bundler
+  guard-rspec
+  guard-shell
   pry
-  rb-fsevent
   rspec
+  rubocop
   ruby-prof
+  simplecov

data/README.md

@@ -0,0 +1,118 @@
+# Aspector
+
+[<img src="https://secure.travis-ci.org/gcao/aspector.png" />](http://travis-ci.org/gcao/aspector)
+
+Aspector = ASPECT Oriented Ruby programming
+
+## About
+
+Aspector allows to use [aspect oriented programming](https://en.wikipedia.org/wiki/Aspect-oriented_programming) with Ruby.
+
+Aspector allows adding additional behavior to existing code (an advice) without modifying the code itself, instead separately specifying which code is modified via a "pointcut" specification.
+
+## Highlights
+
+* Encapsulate logic as aspects and apply to multiple targets easily
+* Support before/before_filter/after/around advices
+* Work anywhere - inside/outside the target class, before/after methods are created
+* Use regexp matching to apply advices to multiple methods
+* Small codebase, intuitive API
+* Conditional aspects disabling/enabling
+* Standarized logging API
+
+
+## Example usages
+
+Aspector should be used whenever you have a cross-cutting concerns, especially when they don't perform any business logic. For example use can use it to provide things like:
+
+* Logging
+* Monitoring
+* Performance benchmarking
+* Any type of transactions wrapping
+* Events producing for systems like Apache Kafka
+* Etc...
+
+## Installation
+
+```bash
+gem install aspector
+```
+
+or put it inside of your Gemfile:
+
+```bash
+gem 'aspector'
+```
+
+## Examples
+
+To see how to use Aspector, please review examples that are in [examples directory](examples/).
+
+If you need more detailed examples, please review files in [spec/functionals](spec/functionals) and [spec/units/advices](spec/units/advices).
+
+Here's a simple example how Aspector can be used:
+
+```ruby
+class ExampleClass
+  def test
+    puts 'test'
+  end
+end
+
+aspect = Aspector do
+  target do
+    def do_this
+      puts 'do_this'
+    end
+  end
+
+  before :test, :do_this
+
+  before :test do
+    puts 'do_that'
+  end
+end
+
+aspect.apply(ExampleClass)
+element = ExampleClass.new
+element.test
+aspect.disable
+element.test
+
+# Expected output
+# do_this
+# do_that
+# test
+# test
+```
+
+## Configuration options
+
+Aspector is really easy to use. After installation it doesn't require any additional configuration. You can however set two environments variables that are related to logging:
+
+| ENV variable name  | Description                                                                          |
+|--------------------|--------------------------------------------------------------------------------------|
+| ASPECTOR_LOGGER    | Any logger class you want to use (if you don't want to use Aspector standard logger) |
+| ASPECTOR_LOG_LEVEL | DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN                                        |
+
+Aspector::Logger inherits from a [standard Ruby logger](http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html). Log levels and the API are pretty standard. You can however use yor own:
+
+```ruby
+ASPECTOR_LOGGER='MyApp::Logger' ASPECTOR_LOG_LEVEL='any log level' ruby aspected_stuff.rb
+```
+
+## Contributing to aspector
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add specs for it. This is important so I don't break it in a future version unintentionally.
+* If it is a new functionality or feature please provide examples
+* Please benchmark any functionality that might have a performance impact
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Guoliang Cao, Maciej Mensfeld. See LICENSE.txt for further details.

data/Rakefile

@@ -1,35 +1,19 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
-require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "aspector"
-  gem.homepage = "http://github.com/gcao/aspector"
-  gem.license = "MIT"
-  gem.summary = %Q{Aspect Oriented Ruby Programming}
-  gem.description = %Q{}
-  gem.email = "gcao99@gmail.com"
-  gem.authors = ["Guoliang Cao"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
-
+task default: :spec