aquarium 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c8e2ff478a03b28cb82786e11db87f2809aeedb30749ca57c93e3da75a8e3
-  data.tar.gz: 027f4f0635c170239546fde6547f8c84a684020046cd940f3466ab9f8bbb45a4
+  metadata.gz: df94cd118d921250a4c653a487c04b8446c311b8901f2fffe0dfb047a66b89f7
+  data.tar.gz: 6822873aecf444624668cbba457e5dad45b243b6d86d7b22f9a73f664fb3ce3a
 SHA512:
-  metadata.gz: de21011f1c22b93eac2de02630836c40759511a80d2d02b6ee626e98a17b41bcaf50d1bb65393da9123b1638e7b503c37075764e30fbb380dd25e216134ac6e3
-  data.tar.gz: 30157999d9b464b2bdcb8808a14ab7f1ed90b89a8959f7cc9fe5ed7cb52f4355c6a4770f6210622d47b3e2ec85fe6e8f80ab917eb74a26d2cedd5d3448fc911f
+  metadata.gz: 1244c4a7b426bdca859e6670323ad5320f078dab7616202aeb1a3a07743825af11f301757049df29339b55f37cada3b5024072ef5a3e4c4532e6b6071681318e
+  data.tar.gz: 73eac1c747752f01250cf22ea4401601da5b65880caac5b53b919cbd7d3e385e36c829f15debf07cba7d7f68c8f4d256f520667b0f7eb5672bc840390e1b3bd9

data/CHANGES

@@ -1,3 +1,9 @@
+== Version 0.7.3
+
+(0.7.2 had documentation errors.)
+
+Removed an ill-advised (if you'll pardon the expression...) use of monkey patching to add a `to_camel_case` method to `String`, which I only used in one place! Instead, I just call a utility to do this.
+
 == Version 0.7.1
 
 Adds support for Ruby 2.6. It was tested with 2.6.3p62 (2019-04-16 revision 67580). Basic JRuby 9.2.7.0 (2.5.3) 2019-04-09 8a269e3 support is provided, but using JRuby currently does *not* pass all the custom Java specs in the `jruby/spec` directory, which specifically test working with Java classes. However, JRuby does pass all the Ruby specs in the `spec` directory. This is a long-standing issue with JRuby support in Aquarium. Patches are welcome!

data/UPGRADE

@@ -1,3 +1,7 @@
+== Updating to Aquarium-0.7.3
+
+Version 0.7.3 has only been tested with Ruby 2.7.0, but it should support the same versions as version 0.7.1, as this release contains only a relatively small set of code changes to fix issue #43.
+
 == Updating to Aquarium-0.7.1
 
 Version 0.7.1 supports only Ruby 2.6. It was tested with 2.6.3p62 (2019-04-16 revision 67580). Basic JRuby 9.2.7.0 (2.5.3) 2019-04-09 8a269e3 support is provided, but using JRuby currently does *not* pass all the custom Java specs in the `jruby/spec` directory, which specifically test working with Java classes. However, JRuby does pass all the Ruby specs in the `spec` directory. This is a long-standing issue with JRuby support in Aquarium. Patches are welcome!

data/aquarium.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
   s.authors = ["Dean Wampler and other contributors"]
   s.email = "deanwampler@gmail.com"
   s.homepage = "https://deanwampler.github.io/open-source/aquarium/index.html"
-  s.rubyforge_project = "aquarium"
   s.description = <<-EOF
     Aquarium is a full-featured Aspect-Oriented Programming (AOP) framework for Ruby that is
     designed to provide an intuitive syntax and support for large-scale, dynamic aspects.

data/lib/aquarium/aspects/advice.rb

@@ -1,29 +1,31 @@
 require 'aquarium/utils/array_utils'
-require 'aquarium/extensions/string'
+require 'aquarium/utils/camel_case'
 require 'aquarium/utils/invalid_options'
 require 'aquarium/utils/nil_object'
 
+include Aquarium::Utils::CamelCase
+
 module Aquarium
   module Aspects
     module Advice
-      
+
       UNKNOWN_ADVICE_KIND = "unknown"
 
-      KINDS_IN_PRIORITY_ORDER = [:around, :before, :after, :after_returning, :after_raising] 
+      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
 
       def self.sort_by_priority_order advice_kinds
-        advice_kinds.sort do |x,y| 
+        advice_kinds.sort do |x,y|
           KINDS_IN_PRIORITY_ORDER.index(x.to_sym) <=> KINDS_IN_PRIORITY_ORDER.index(y.to_sym)
         end.map {|x| x.to_sym}
       end
-      
+
       def self.compare_advice_kinds kind1, kind2
         if kind1.nil?
           return kind2.nil? ? 0 : -1
@@ -35,18 +37,18 @@ module Aquarium
           return kind2.eql?(UNKNOWN_ADVICE_KIND) ? 1 : KINDS_IN_PRIORITY_ORDER.index(kind1) <=> KINDS_IN_PRIORITY_ORDER.index(kind2)
         end
       end
-      
-    end  
+
+    end
 
     # Supports Enumerable, but not the sorting methods, as this class is a linked list structure.
     # This is of limited usefulness, because you wouldn't use an iterator to invoke the procs
     # in the chain, because each proc will invoke the next node arbitrarily or possibly not at all
     # in the case of around advice!
-    class AdviceChainNode 
+    class AdviceChainNode
       include Enumerable
       def initialize options = {}
         # assign :next_node and :static_join_point so the attributes are always created
-        options[:next_node] ||= nil  
+        options[:next_node] ||= nil
         options[:static_join_point] ||= nil
         options.each do |key, value|
           instance_variable_set "@#{key}".intern, value
@@ -55,7 +57,7 @@ module Aquarium
           EOF
         end
       end
-        
+
       # Bug #19262 workaround: need to only pass jp argument if arity is 1.
       def call_advice jp
         if advice.arity == 1
@@ -64,7 +66,7 @@ module Aquarium
           advice.call jp, jp.context.advised_object, *jp.context.parameters
         end
       end
-  
+
       def call jp
         begin
           advice_wrapper jp
@@ -72,7 +74,7 @@ module Aquarium
           handle_call_rescue e, "", jp
         end
       end
-      
+
       def invoke_original_join_point current_jp
         begin
           last.advice_wrapper current_jp
@@ -80,41 +82,41 @@ module Aquarium
           handle_call_rescue e, "While executing the original join_point: ", current_jp
         end
       end
-      
+
       # Supports Enumerable
-      def each 
-        node = self 
-        while node.nil? == false 
-          yield node 
-          node = node.next_node 
-        end 
+      def each
+        node = self
+        while node.nil? == false
+          yield node
+          node = node.next_node
+        end
       end
-      
+
       def last
         last_node = nil
-        each { |node| last_node = node unless node.nil? } 
+        each { |node| last_node = node unless node.nil? }
         last_node
       end
-      
+
       def size
         inject(0) {|memo, node| memo += 1}
       end
-      
+
       def empty?
         next_node.nil?
       end
-  
+
       # TODO: remove this method, which causes run-away recursions in R1.9.1
       # def inspect &block
-      #   block ? yield(self) : super 
+      #   block ? yield(self) : super
       # end
-  
+
       NIL_OBJECT = Aquarium::Utils::NilObject.new
-      
+
       protected
-      
+
       #--
-      # For performance reasons, we don't clone the context. 
+      # For performance reasons, we don't clone the context.
       # TODO: There are potential concurrency issues!
       #++
       def update_current_context jp
@@ -124,12 +126,12 @@ module Aquarium
         jp.context.current_advice_node = self
       end
 
-      def reset_current_context jp 
+      def reset_current_context jp
         return if advice.arity == 0
         jp.context.advice_kind = @last_advice_kind
         jp.context.current_advice_node = @last_advice_node
       end
-      
+
       def handle_call_rescue ex, error_message_prefix, jp
         if Aquarium::Aspects::Advice.debug_backtraces
           class_or_instance_method_separater = jp.instance_method? ? "#" : "."
@@ -154,7 +156,7 @@ module Aquarium
     # rather than object.method(...).call(*args). The latter fails when the original method
     # calls super. This is a Ruby bug: http://www.ruby-forum.com/topic/124276
     class NoAdviceChainNode < AdviceChainNode
-      # Note that we extract the block passed to the original method call, if any, 
+      # Note that we extract the block passed to the original method call, if any,
       # from the context and pass it to method invocation.
       def initialize options = {}
         super options
@@ -166,7 +168,7 @@ module Aquarium
 
     class BeforeAdviceChainNode < AdviceChainNode
       def initialize options = {}
-        super options 
+        super options
       end
       def advice_wrapper jp
         update_current_context jp
@@ -220,11 +222,11 @@ module Aquarium
       def after_raising_exceptions_list_includes raised_exception
         after_raising_exceptions_list.find {|x| raised_exception.kind_of? x}
       end
-  
-      def after_raising_exceptions_list 
+
+      def after_raising_exceptions_list
         list = @after_raising.kind_of?(Set) ? @after_raising.to_a : @after_raising
         (list.nil? || list.empty? || (list.size == 1 && list[0] == "")) ? [Object] : list
-      end    
+      end
     end
 
     class AfterAdviceChainNode < AdviceChainNode
@@ -232,7 +234,7 @@ module Aquarium
         super options
       end
       def advice_wrapper jp
-        # call_advice is invoked in each bloc, rather than once in an "ensure" clause, so the invocation in 
+        # call_advice is invoked in each bloc, rather than once in an "ensure" clause, so the invocation in
         # the rescue clause can allow the advice to change the exception that will be raised.
         begin
           returned_value = next_node.call jp
@@ -270,18 +272,18 @@ module Aquarium
     end
 
     # The advice_kind argument must be one of the values returned by Advice.kinds or one of the special values
-    # ":no" or ":none", signfying a node for which there is no advice, where the actual method being advised is 
+    # ":no" or ":none", signfying a node for which there is no advice, where the actual method being advised is
     # called directly instead. This kind of node is normally used as the terminal leaf in the chain.
     module AdviceChainNodeFactory
       def self.make_node options = {}
         advice_kind = options[:advice_kind]
         raise Aquarium::Utils::InvalidOptions.new("Unknown advice kind specified: #{advice_kind}") unless valid(advice_kind)
         advice_kind = :no if advice_kind == :none
-        advice_chain_node_name = advice_kind.to_s.to_camel_case + "AdviceChainNode"
+        advice_chain_node_name = Aquarium::Utils::CamelCase.to_camel_case(advice_kind.to_s) + "AdviceChainNode"
         clazz = Aquarium::Aspects.const_get advice_chain_node_name
         clazz.new options
       end
-  
+
       def self.valid advice_kind
         advice_kind == :no || advice_kind == :none || Advice.kinds.include?(advice_kind)
       end

data/lib/aquarium/extensions.rb

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

data/lib/aquarium/utils.rb

@@ -1,6 +1,7 @@
 require 'aquarium/utils/array_utils'
 require 'aquarium/utils/hash_utils'
 require 'aquarium/utils/set_utils'
+require 'aquarium/utils/camel_case'
 
 require 'aquarium/utils/method_utils'
 require 'aquarium/utils/name_utils'

data/lib/aquarium/utils/camel_case.rb

@@ -0,0 +1,18 @@
+module Aquarium
+  module Utils
+    module CamelCase
+      def to_camel_case str
+        str.split('_').map {|s| s[0,1]=s[0,1].capitalize; s}.join
+      end
+
+      def to_snake_case str
+        str.gsub(/([A-Z]+[a-z0-9_-]*)/, '\1_').downcase.gsub(/__*/, '_').gsub(/_$/, '').gsub(/^_/, '')
+      end
+    end
+  end
+end
+
+# bad id, as at least one other library wants to define from on string
+# class String
+#   include Aquarium::Extensions::CamelCase
+# end

data/lib/aquarium/version.rb

@@ -9,7 +9,7 @@ module Aquarium
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 7
-      TINY   = 1
+      TINY   = 3
       RELEASE_CANDIDATE = nil
 
       # RANDOM_TOKEN: 0.598704893979657

data/spec/aquarium/utils/camel_case_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'aquarium/utils/camel_case'
+
+describe  CamelCase, "#to_camel_case" do
+  it "should return a camel-case string unchanged" do
+    CamelCase.to_camel_case("CamelCaseString").should == "CamelCaseString"
+  end
+
+  it "should return a camel-case string from an input string with substrings separated by underscores" do
+    CamelCase.to_camel_case("camel_case_string").should == "CamelCaseString"
+  end
+
+  it "should return a camel-case string with the first letters of each substring in uppercase and the rest of the letters in each substring unchanged" do
+    CamelCase.to_camel_case("cAmEl_cASE_stRinG").should == "CAmElCASEStRinG"
+  end
+
+  it "should remove leading and trailing underscores" do
+    CamelCase.to_camel_case("camel_case_string_").should    == "CamelCaseString"
+    CamelCase.to_camel_case("_camel_case_string").should    == "CamelCaseString"
+    CamelCase.to_camel_case("camel_case_string__").should   == "CamelCaseString"
+    CamelCase.to_camel_case("__camel_case_string").should   == "CamelCaseString"
+    CamelCase.to_camel_case("_camel_case_string_").should   == "CamelCaseString"
+    CamelCase.to_camel_case("__camel_case_string__").should == "CamelCaseString"
+  end
+end
+
+describe  CamelCase, "#to_snake_case" do
+  it "should return a snake-case string unchanged" do
+    CamelCase.to_snake_case("camel_case_string").should == "camel_case_string"
+  end
+
+  it "should return a snake-case string to an input string with substrings separated by underscores" do
+    CamelCase.to_snake_case("CamelCaseString").should == "camel_case_string"
+  end
+
+  it "should return a snake-case string with all characters converted to lower case" do
+    CamelCase.to_snake_case("CamelCaseString").should == "camel_case_string"
+  end
+
+  it "should partition the words by [A-Z]+[a-z0-9]*" do
+    CamelCase.to_snake_case("CAmElCASEStRinG").should == "cam_el_casest_rin_g"
+  end
+
+  it "should preserve embedded underscores" do
+    CamelCase.to_snake_case("C_Am_ElCA_SEStR_inG").should == "c_am_el_ca_sest_r_in_g"
+  end
+
+  it "should remove leading, trailing, and repeated underscores" do
+    puts CamelCase.to_snake_case("_Camel__CaseString_")
+    CamelCase.to_snake_case("_Camel__CaseString_").should    == "camel_case_string"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aquarium
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Dean Wampler and other contributors
 autorequire: aquarium
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,7 +205,6 @@ files:
 - lib/aquarium/extensions/hash.rb
 - lib/aquarium/extensions/regexp.rb
 - lib/aquarium/extensions/set.rb
-- lib/aquarium/extensions/string.rb
 - lib/aquarium/extras.rb
 - lib/aquarium/extras/design_by_contract.rb
 - lib/aquarium/finders.rb
@@ -215,6 +214,7 @@ files:
 - lib/aquarium/finders/type_finder.rb
 - lib/aquarium/utils.rb
 - lib/aquarium/utils/array_utils.rb
+- lib/aquarium/utils/camel_case.rb
 - lib/aquarium/utils/default_logger.rb
 - lib/aquarium/utils/hash_utils.rb
 - lib/aquarium/utils/html_escaper.rb
@@ -251,7 +251,6 @@ files:
 - spec/aquarium/extensions/hash_spec.rb
 - spec/aquarium/extensions/regex_spec.rb
 - spec/aquarium/extensions/set_spec.rb
-- spec/aquarium/extensions/string_spec.rb
 - spec/aquarium/extras/design_by_contract_spec.rb
 - spec/aquarium/finders/finder_result_spec.rb
 - spec/aquarium/finders/method_finder_spec.rb
@@ -263,6 +262,7 @@ files:
 - spec/aquarium/spec_example_types.rb
 - spec/aquarium/spec_helper.rb
 - spec/aquarium/utils/array_utils_spec.rb
+- spec/aquarium/utils/camel_case_spec.rb
 - spec/aquarium/utils/default_logger_spec.rb
 - spec/aquarium/utils/hash_utils_spec.rb
 - spec/aquarium/utils/html_escaper_spec.rb
@@ -293,10 +293,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Aquarium-0.7.1 (r7) - Aspect-Oriented Programming toolkit for Ruby http://aquarium.rubyforge.org
+summary: Aquarium-0.7.3 (r7) - Aspect-Oriented Programming toolkit for Ruby http://aquarium.rubyforge.org
 test_files:
 - spec/aquarium/aspects/advice_chain_node_spec.rb
 - spec/aquarium/aspects/advice_spec.rb
@@ -316,7 +316,6 @@ test_files:
 - spec/aquarium/extensions/hash_spec.rb
 - spec/aquarium/extensions/regex_spec.rb
 - spec/aquarium/extensions/set_spec.rb
-- spec/aquarium/extensions/string_spec.rb
 - spec/aquarium/extras/design_by_contract_spec.rb
 - spec/aquarium/finders/finder_result_spec.rb
 - spec/aquarium/finders/method_finder_spec.rb
@@ -328,6 +327,7 @@ test_files:
 - spec/aquarium/spec_example_types.rb
 - spec/aquarium/spec_helper.rb
 - spec/aquarium/utils/array_utils_spec.rb
+- spec/aquarium/utils/camel_case_spec.rb
 - spec/aquarium/utils/default_logger_spec.rb
 - spec/aquarium/utils/hash_utils_spec.rb
 - spec/aquarium/utils/html_escaper_spec.rb

data/lib/aquarium/extensions/string.rb

@@ -1,13 +0,0 @@
-module Aquarium
-  module Extensions
-    module StringHelper
-      def to_camel_case
-        split('_').map {|s| s[0,1]=s[0,1].capitalize; s}.join
-      end
-    end
-  end
-end
-
-class String
-  include Aquarium::Extensions::StringHelper
-end

data/spec/aquarium/extensions/string_spec.rb

@@ -1,25 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-require 'aquarium/extensions/string'
-
-describe  String, "#to_camel_case" do
-  it "should return a camel-case string unchanged" do
-    "CamelCaseString".to_camel_case.should == "CamelCaseString"
-  end
-
-  it "should return a camel-case string from an input string with substrings separated by underscores" do
-    "camel_case_string".to_camel_case.should == "CamelCaseString"
-  end
-
-  it "should return a camel-case string with the first letters of each substring in uppercase and the rest of the letters in each substring unchanged" do
-    "cAmEl_cASE_stRinG".to_camel_case.should == "CAmElCASEStRinG"
-  end
-
-  it "should remove leading and trailing underscores" do
-    "camel_case_string_".to_camel_case.should    == "CamelCaseString"
-    "_camel_case_string".to_camel_case.should    == "CamelCaseString"
-    "camel_case_string__".to_camel_case.should   == "CamelCaseString"
-    "__camel_case_string".to_camel_case.should   == "CamelCaseString"
-    "_camel_case_string_".to_camel_case.should   == "CamelCaseString"
-    "__camel_case_string__".to_camel_case.should == "CamelCaseString"
-  end
-end