aquarium 0.4.4 → 0.5.1

data/CHANGES

@@ -1,14 +1,39 @@
-== Version 0.4.4
+== Version 0.5.1
 
-V0.4.4 changes no APIs. It upgrades compatibility with the latest JRuby (1.3.1), RSpec (1.2.8) and Webgen (0.5.10) for the build process. You'll only need to upgrade if you build Aquarium yourself.
+V0.5.1 adds support for Ruby 1.8.7, Ruby 1.9.3, JRuby 1.6.7,
+RSpec 2.9, and Webgen (0.5.14 - for the build process).
+
+WARNING: Earlier versions of Ruby 1.8, 1.9 and JRuby 1.X are not 
+supported. JRuby support is limited to "pure" Ruby code; the main
+RSpec specifications pass under JRuby, but not the JRuby-specific 
+specifications in jruby/spec. Restoring full JRuby support is planned, 
+but the timeframe is TBD.
+
+It also has some minor API changes summarized below.
 
 Enhancements:
-27235	Support RSpec 1.2.8 (latest) and and JRuby 1.3.1 (latest)
-27236	Upgrade website generation to webgen 0.5.X
+22558	Support Ruby 1.9.1 (actually 1.9.3)
+27235	Support RSpec 1.2.8 (actually 2.9) and and JRuby 1.3.1 (actually 1.6.7)
+27236	Upgrade website generation to webgen 0.5.X (X=14)
+
+The actual versions of these tools supported are more recent versions 
+shown in parentheses.
+
+There are no API changes in this release, with two exceptions. 
+
+First, Most of the code changes are minor fixes to RSpec files. The one 
+exception is an apparent change that occurred in JRuby 1.3.X with respect 
+to the access restrictions on Java methods. It now appears that protected 
+methods are public, that is they are in the method list returned by 
+:public_methods, but not :protected_methods. Also, private methods are 
+not returned by any of the :*_methods. 
+
+Second, there was a deprecated option to the MethodFinder class, 
+:options, that has been removed. Use :method_options instead.
 
-There are no API changes in this release, with one exception. Most of the code changes are minor fixes to RSpec files. The one exception is an apparent change in JRuby 1.3.1 w.r.t. the access restrictions on Java methods. It now appears that protected methods are public, that is they are in the method list returned by :public_methods, but not :protected_methods. Also, private methods are not returned by any of the :*_methods. 
+I used the upgrade to Webgen 0.5.X as an excuse to refresh the web site's 
+appearance. The content is mostly the same as before.
 
-I used the upgrade to Webgen 0.5.X as an excuse to refresh the web site's appearance. The content is mostly the same as before.
 
 == Version 0.4.3
 

data/README

@@ -463,7 +463,10 @@ See http://aquarium.rubyforge.org for further documentation.
 === Acknowledgments
 
 My colleagues in the AOSD community, in particular those who developed AspectJ, have been a big inspiration.
+
 The RSpec team, in particular David Chelimsky, have really inspired my thinking about what's possible in Ruby, especially in the realm of DSLs. I also cribbed parts of the RSpec Rake process ;)
-My colleagues at Object Mentor are an endless source of insight and inspiration.
+
+Keita Yamaguchi contributed some key patches that enabled Ruby 1.9.3 and JRuby 1.6.7 support, in addition to the prior support for Ruby 1.8.7. These patches allowed me to final release version 0.5.X. Thank you!
+
 Finally, a number of users have contributed valuable feedback. In particular, thanks to Brendan L., Matthew F., and Mark V. 
  

data/RELEASE-PLAN

@@ -62,6 +62,8 @@ aspects, for example.
 I'll maintain the current form for backwards compatibility and also because it is convenient for
 simpler aspects.
 
+Finally, this release will finally support Ruby 1.9.X and the latest JRuby at the time of the release.
+
 === Version 0.6+
 
 I have been thinking about higher-order abstractions that work above the "Pointcut + Advice

data/Rakefile

@@ -4,18 +4,16 @@ require 'rake'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'rake/clean'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'aquarium/version'
 
 # Use RSpec's files.
-require 'spec/rake/spectask'
-require 'spec/rake/verify_rcov'
-
-# TODO: add ../README.markdown to archives.
+require 'rspec/core/rake_task'
 
 # Some of the tasks are in separate files since they are also part of the website documentation
-load File.dirname(__FILE__) + '/rake_tasks/examples.rake'
-load File.dirname(__FILE__) + '/rake_tasks/verify_rcov.rake'
+#load File.dirname(__FILE__) + '/rake_tasks/examples.rake'
+# TODO: Replace rcov with simplecov and restore this feature.
+#load File.dirname(__FILE__) + '/rake_tasks/verify_rcov.rake'
 
 PKG_NAME = "aquarium"
 PKG_VERSION   = Aquarium::VERSION::STRING
@@ -29,34 +27,25 @@ PKG_FILES = FileList[
 ]
 FileUtils.touch(File.dirname(__FILE__) + '/previous_failures.txt')
 
-task :default => [:verify_rcov]
+IS_WINDOWS = (RUBY_VERSION == "1.8.7" ? PLATFORM : RUBY_PLATFORM) =~ /mswin/
 
-desc "Run all specs"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb', 'examples/**/*_spec.rb']
-  t.spec_opts = ['--options', 'spec.opts']
-  t.rcov = true
-  t.rcov_dir = '../doc/aquarium/out/coverage'
-  t.rcov_opts = ['--exclude', 'examples']
-end
+task :default => :spec  
 
-desc "Run all specs and store html output in doc/aquarium/out/report.html"
-Spec::Rake::SpecTask.new('spec_html') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb', 'examples/**/*_spec.rb']
-  t.spec_opts = ['--format html:../doc/aquarium/out/report.html','--backtrace']
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--color', '--format progress', '--profile']
 end
 
-desc "Run all specs without rcov"
-Spec::Rake::SpecTask.new('spec_no_rcov') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb', 'examples/**/*_spec.rb']
-  t.spec_opts = ['--colour']
-end
+# desc "Run all specs and store html output in doc/aquarium/out/report.html"
+# RSpec::Core::RakeTask.new('spec_html') do |t|
+#   t.rspec_opts = ['--format html:../doc/aquarium/out/report.html','--backtrace']
+# end
 
 desc 'Generate HTML documentation for website'
 task :webgen do
   Dir.chdir '../doc/aquarium' do
     output = nil
-    IO.popen('webgen 2>&1') do |io|
+    IO.popen('rake webgen 2>&1') do |io|
       output = io.read
     end
     raise "ERROR while running webgen: #{output}" if output =~ /ERROR/n || $? != 0
@@ -127,6 +116,7 @@ end
 
 task :clobber do
   rm_rf '../doc/aquarium/out'
+  rm_rf '../doc/aquarium/webgen.cache'
   rm_rf 'translated_specs'
 end
 
@@ -166,20 +156,20 @@ end
 # ]
 
 desc "Build the website, but do not publish it"
-task :website => [:clobber, :verify_rcov, :verify_jruby, :spec_html, :webgen, :rdoc]
+task :website => [:clobber, :rdoc, :webgen] # :spec_html, :verify_jruby, :verify_rcov,
 
 task :rdoc_rails do
   Dir.chdir '../aquarium_on_rails' do
-    rake = (PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake"
+    rake = IS_WINDOWS ? "rake.cmd" : "rake"
     `#{rake} rdoc`
   end
 end
 
-desc "Verify that the Aquarium specs run under JRuby and that JRuby can advise Java types"
+desc "Verify that the Aquarium specs run under JRuby and that JRuby can advise Java types. If this task fails, try running 'jruby -S rake' separately."
 task :verify_jruby do
   puts "Verifying JRuby Support"
   Dir.chdir 'jruby' do
-    rake = (PLATFORM == "i386-mswin32") ? "rake.cmd" : "rake"
+    rake = IS_WINDOWS ? "rake.cmd" : "rake"
     sh "jruby -S #{rake}"
   end
 end

data/UPGRADE

@@ -1,8 +1,18 @@
-== Updating to Aquarium-0.4.0
+== Updating to Aquarium-0.5.X
 
-This release is fully backwards-compatible with previous releases. It expands
-the API slightly and adds internal improvements to better support JRuby. There
-should be no upgrade issues. 
+This release introduces a few small API changes that are described in 
+CHANGES. The primary goal of the release is to add full support for 
+Ruby 1.9.3 and JRuby 1.6.7.
+
+It was not tested on early versions of Ruby 1.9 and JRuby 1.X, so users 
+of earlier releases should use caution upgrading. Post any issues to the 
+GitHub project.
+
+== Updating to Aquarium-0.4.X
+
+This release is fully backwards-compatible with previous releases. It 
+expands the API slightly and adds internal improvements to better support 
+JRuby. There should be no upgrade issues. 
 
 == Updating to Aquarium-0.3.1
 

data/lib/aquarium/aspects/advice.rb

@@ -1,6 +1,5 @@
 require 'aquarium/utils/array_utils'
 require 'aquarium/extensions/string'
-require 'aquarium/extensions/symbol'
 require 'aquarium/utils/invalid_options'
 require 'aquarium/utils/nil_object'
 
@@ -11,6 +10,11 @@ module Aquarium
       UNKNOWN_ADVICE_KIND = "unknown"
 
       KINDS_IN_PRIORITY_ORDER = [:around, :before, :after, :after_returning, :after_raising] 
+
+      @DEBUG_BACKTRACES = false
+
+      def self.debug_backtraces; @DEBUG_BACKTRACES; end
+      def self.debug_backtraces=( val ); @DEBUG_BACKTRACES = val; end
       
       def self.kinds; KINDS_IN_PRIORITY_ORDER; end
 
@@ -100,9 +104,10 @@ module Aquarium
         next_node.nil?
       end
   
-      def inspect &block
-        block ? yield(self) : super 
-      end
+      # TODO: remove this method, which causes run-away recursions in R1.9.1
+      # def inspect &block
+      #   block ? yield(self) : super 
+      # end
   
       NIL_OBJECT = Aquarium::Utils::NilObject.new
       
@@ -126,12 +131,22 @@ module Aquarium
       end
       
       def handle_call_rescue ex, error_message_prefix, jp
-        class_or_instance_method_separater = jp.instance_method? ? "#" : "."
-        context_message = error_message_prefix + "Exception raised while executing \"#{jp.context.advice_kind}\" advice for \"#{jp.type_or_object.inspect}#{class_or_instance_method_separater}#{jp.method_name}\": "
-        backtrace = ex.backtrace
-        e2 = ex.exception(context_message + ex.message + " (join_point = #{jp.inspect})")
-        e2.set_backtrace backtrace
-        raise e2
+        if Aquarium::Aspects::Advice.debug_backtraces
+          class_or_instance_method_separater = jp.instance_method? ? "#" : "."
+          context_message = error_message_prefix + "Exception raised while executing \"#{jp.context.advice_kind}\" advice for \"#{jp.type_or_object.inspect}#{class_or_instance_method_separater}#{jp.method_name}\": "
+
+          # Don't prepend the same context message multiple times
+          if ex.message =~ /#{context_message}/
+            context_message = ""
+          end
+
+          backtrace = ex.backtrace
+          e2 = ex.exception(context_message + ex.message + " (join_point = #{jp.inspect})")
+          e2.set_backtrace backtrace
+          raise e2
+        else
+          raise ex
+        end
       end
     end
 

data/lib/aquarium/aspects/aspect.rb

@@ -37,7 +37,7 @@ module Aquarium
         "pointcuts"         => %w[pointcut],
         "named_pointcuts"   => %w[named_pointcut],
         "exceptions"        => %w[exception],
-        "ignore_no_matching_join_points" => %[ignore_no_jps]
+        "ignore_no_matching_join_points" => %w[ignore_no_jps]
       }
       ["pointcuts", "named_pointcuts"].each do |pc_option|
         add_prepositional_option_variants_for pc_option, ASPECT_CANONICAL_OPTIONS
@@ -341,7 +341,7 @@ module Aquarium
       end
 
       def join_point_for_aspect_implementation_method? join_point
-        join_point.method_name.to_s.index("#{Aspect.aspect_method_prefix}") == 0
+        join_point.method_name.to_s.index(Aspect.aspect_method_prefix.to_s) == 0
       end
       
       def add_advice_to_chain join_point, advice_kind, advice
@@ -375,12 +375,12 @@ module Aquarium
       end
 
       def need_advice_framework? join_point
-        alias_method_name = (Aspect.make_saved_method_name join_point).intern
+        alias_method_name = (Aspect.make_saved_method_name join_point)
         private_method_defined?(join_point, alias_method_name) == false
       end
       
       def add_advice_framework join_point
-        alias_method_name = (Aspect.make_saved_method_name join_point).intern
+        alias_method_name = (Aspect.make_saved_method_name join_point)
         type_to_advise = Aspect.type_to_advise_for join_point
         # Note: Must set advice chain, a class variable on the type we're advising, FIRST. 
         # Otherwise the class_eval that follows will assume the @@ advice chain belongs to Aspect!
@@ -496,7 +496,7 @@ module Aquarium
       end
   
       def restore_original_method_text join_point
-        alias_method_name = (Aspect.make_saved_method_name join_point).intern
+        alias_method_name = (Aspect.make_saved_method_name join_point)
         <<-EOF
           #{join_point.instance_method? ? "" : "class << self"}
           #{unalias_original_method_text alias_method_name, join_point}
@@ -527,7 +527,8 @@ module Aquarium
 
       def private_method_defined? join_point, alias_method_name
         type_to_advise = Aspect.type_to_advise_for join_point
-        type_to_advise.send(:private_instance_methods).include? alias_method_name.to_s
+        method_name = Aquarium::Utils::MethodUtils.to_name alias_method_name
+        type_to_advise.send(:private_instance_methods).include? method_name
       end
   
       def self.make_advice_chain_attr_sym join_point
@@ -540,7 +541,7 @@ module Aquarium
       def self.make_saved_method_name join_point
         type_or_object_key = make_type_or_object_key join_point
         valid_name = Aquarium::Utils::NameUtils.make_valid_attr_name_from_method_name join_point.method_name
-        "#{Aspect.aspect_method_prefix}saved_#{type_or_object_key}_#{valid_name}"
+        "#{Aspect.aspect_method_prefix}saved_#{type_or_object_key}_#{valid_name}".intern
       end
   
       def self.aspect_method_prefix

data/lib/aquarium/aspects/join_point.rb

@@ -58,7 +58,12 @@ module Aquarium
         
         alias :to_s :inspect
     
-        # We require the same object id, not just equal objects.
+        def inspect
+          "JoinPoint::Context: {advice_kind = #{advice_kind}, advised_object = #{advised_object}, parameters = #{parameters}, " +
+          "proceed_proc = #{proceed_proc}, current_advice_node = #{current_advice_node.inspect}, returned_value = #{returned_value}, " +
+          "raised_exception = #{raised_exception}, block_for_method = #{block_for_method}}"
+        end
+
         def <=> other
           return 0 if object_id == other.object_id 
           return 1 if other.nil?
@@ -166,7 +171,6 @@ module Aquarium
         @instance_method
       end
       
-      # We require the same object id, not just equal objects.
       def <=> other
         return 0  if object_id == other.object_id 
         return 1  if other.nil?
@@ -190,13 +194,13 @@ module Aquarium
       alias :==  :eql?
       alias :=== :eql?
   
+      #todo: restore context output.
       def inspect
-        "JoinPoint: {target_type = #{target_type.inspect}, target_object = #{target_object.inspect}, method_name = #{method_name}, instance_method? #{instance_method?}, context = #{context.inspect}}"
+        "JoinPoint: {target_type = #{target_type.nil? ? target_type : target_type.name}, target_object = #{target_object.inspect}, method_name = #{method_name}, instance_method? #{instance_method?}, context = #{context.inspect}"
       end
   
       alias :to_s :inspect
 
-  
       protected
   
       def compare_field field_reader, other
@@ -207,7 +211,13 @@ module Aquarium
         else
           return 1 if field2.nil?
         end
-        block_given? ? (yield field1, field2) : (field1 <=> field2)
+        if block_given?
+          yield field1, field2
+        elsif field1.respond_to?(:<=>)
+          field1 <=> field2
+        else
+          field1.to_s <=> field2.to_s
+        end
       end
       
       def boolean_compare b1, b2

data/lib/aquarium/aspects/pointcut.rb

@@ -206,13 +206,13 @@ module Aquarium
       # if you care only about the matched join points, then just compare #join_points_matched
       def eql? other
         object_id == other.object_id || 
-        (self.class === other &&
+        (self.class == other.class &&
          specification == other.specification && 
          candidate_types == other.candidate_types && 
          candidate_types_excluded == other.candidate_types_excluded && 
          candidate_objects == other.candidate_objects && 
-         join_points_not_matched == other.join_points_not_matched &&
-         join_points_matched == other.join_points_matched)  # not_matched is probably smaller, so do first.
+         join_points_matched == other.join_points_matched &&
+         join_points_not_matched == other.join_points_not_matched)
       end
   
       alias :== :eql?
@@ -250,7 +250,7 @@ module Aquarium
       def self.make_attribute_reading_writing_options options_hash
         result = {}
         [:writing, :changing, :reading].each do |attr_key|
-          next if options_hash[attr_key].nil? or options_hash[attr_key].empty?
+          next if options_hash[attr_key].nil? or options_hash[attr_key].to_s.empty?
           result[:attributes] ||= Set.new([])
           result[:attribute_options] ||= Set.new([])
           result[:attributes].merge(Aquarium::Utils::ArrayUtils.make_array(options_hash[attr_key]))

data/lib/aquarium/extensions.rb

@@ -2,4 +2,3 @@ require 'aquarium/extensions/hash'
 require 'aquarium/extensions/regexp'
 require 'aquarium/extensions/set'
 require 'aquarium/extensions/string'
-require 'aquarium/extensions/symbol'

data/lib/aquarium/finders/method_finder.rb

@@ -62,10 +62,9 @@ module Aquarium
       # By default, the searches are restricted to public instance methods. 
       # * <tt>:method_options => options</tt>
       # * <tt>:method_option => options</tt>
-      # * <tt>:options  => options</tt>
       # * <tt>:restricting_methods_to => options</tt>
       #     
-      # Note, the <tt>:options</tt> synonym is deprecated.
+      # Note, the older, deprecated <tt>:options</tt> synonym has been removed.
       #
       # Here are the allowed "options". Specify one or more of them. Any combination is allowed.
       # <tt>:public</tt> or <tt>:public_methods</tt>::       Search for public methods (default).
@@ -95,7 +94,6 @@ module Aquarium
         init_specification options, CANONICAL_OPTIONS do
           finish_specification_initialization 
         end
-        warn_if_deprecated_options_used options
         return Aquarium::Finders::FinderResult.new if nothing_to_find?
         types_and_objects = input_types + input_objects
         method_names_or_regexps = input_methods
@@ -116,7 +114,7 @@ module Aquarium
       METHOD_FINDER_CANONICAL_OPTIONS = {
         "objects" => %w[object for_object for_objects on_object on_objects in_object in_objects within_object within_objects],
         "methods" => %w[method within_method within_methods calling invoking invocations_of calls_to sending_message_to sending_messages_to],
-        "method_options" => %w[options method_option restricting_methods_to] 
+        "method_options" => %w[method_option restricting_methods_to] 
       }
       
       %w[objects methods].each do |key|
@@ -161,7 +159,7 @@ module Aquarium
           end
         end
         options << :instance unless (options.include?(:class) or options.include?(:singleton))
-        Set.new(options.sort.uniq)
+        Set.new(options.sort{|x,y| x.to_s <=> y.to_s}.uniq)
       end
   
       def self.all_recognized_method_option_symbols
@@ -179,11 +177,6 @@ module Aquarium
   
       private
   
-      def warn_if_deprecated_options_used options
-        return unless options[:options]
-        logger.warn "The :options => ... option is now deprecated. Please use :method_options instead."
-      end
-  
       def do_find_all_by types_and_objects, method_names_or_regexps
         types_and_objects = make_array types_and_objects
         names_or_regexps  = make_methods_array method_names_or_regexps

data/lib/aquarium/finders/pointcut_finder.rb

@@ -107,7 +107,7 @@ module Aquarium
         types.each do |t|
           candidates = t.constants.select {|c| matches_name(c, names)}
           candidates.each do |c|
-            if t.const_defined? c
+            if is_const_defined? t, c
               con = t.const_get c
               pointcuts.append_matched({t => con}) if con.kind_of?(Aquarium::Aspects::Pointcut)
             end
@@ -116,6 +116,16 @@ module Aquarium
         pointcuts
       end
       
+      # Handle Ruby 1.8 vs. 1.9. We don't want to return true
+      # if the const is defined in an ancestor.
+      def is_const_defined? type, name
+        if RUBY_VERSION =~ /^1.8/
+          type.const_defined? name
+        else
+          type.const_defined? name, false
+        end
+      end
+      
       def find_class_variable_pointcuts types, names = :all
         pointcuts = PoincutFinderResult.new
         types.each do |t|
@@ -131,11 +141,11 @@ module Aquarium
       def matches_name candidate, names
         return true if names == :all
         if names.kind_of? Regexp
-          names.match candidate
+          names.match candidate.to_s
         elsif names.kind_of?(String) or names.kind_of?(Symbol)
-          names.to_s.eql? candidate
+          names.to_s.eql? candidate.to_s
         else
-          names.inject(false) {|matches, name| matches = true if matches_name(candidate, name); matches}
+          names.any? {|name| matches_name(candidate, name)}
         end
       end
       
@@ -146,7 +156,7 @@ module Aquarium
         elsif names.kind_of?(String) or names.kind_of?(Symbol)
           names.to_s =~ /^@@/ ? names.to_s : "@@#{names}"
         else
-          names.inject([]) {|result, name| result << to_class_variable_name(name); result}
+          names.inject([]) {|result, name| result << to_class_variable_name(name)}
         end
       end