Change Stackdriver::Core::Configuration#add_nested to #add_options

hxiong388 · hxiong388 · commit b80da3fa39b2 · 2017-05-18T17:33:27.000-07:00
diff --git a/google-cloud-debugger/lib/google/cloud/debugger.rb b/google-cloud-debugger/lib/google/cloud/debugger.rb
@@ -323,7 +323,7 @@ module Debugger
       # Initialize :error_reporting as a nested Configuration under
       # Google::Cloud if haven't already
       unless Google::Cloud.configure.option? :debugger
-        Google::Cloud.configure.add_nested :debugger
+        Google::Cloud.configure.add_options :debugger
       end
 
       ##
diff --git a/google-cloud-debugger/test/google/cloud/debugger_test.rb b/google-cloud-debugger/test/google/cloud/debugger_test.rb
@@ -137,6 +137,16 @@
     end
   end
 
+  describe ".configure" do
+    it "has Google::Cloud.configure.debugger initialized already" do
+      Google::Cloud.configure.option?(:debugger).must_equal true
+    end
+
+    it "operates on the same Configuration object as Google::Cloud.configure.debugger" do
+      Google::Cloud::Debugger.configure.must_equal Google::Cloud.configure.debugger
+    end
+  end
+
   describe "Debugger.new" do
     let(:default_credentials) { OpenStruct.new empty: true }
     let(:default_module_name) { "default-utest-service" }
diff --git a/google-cloud-error_reporting/lib/google/cloud/error_reporting.rb b/google-cloud-error_reporting/lib/google/cloud/error_reporting.rb
@@ -74,7 +74,7 @@ module ErrorReporting
       # Initialize :error_reporting as a nested Configuration under
       # Google::Cloud if haven't already
       unless Google::Cloud.configure.option? :error_reporting
-        Google::Cloud.configure.add_nested :error_reporting
+        Google::Cloud.configure.add_options :error_reporting
       end
 
       ##
diff --git a/google-cloud-logging/lib/google/cloud/logging.rb b/google-cloud-logging/lib/google/cloud/logging.rb
@@ -332,7 +332,7 @@ module Logging
       # Initialize :error_reporting as a nested Configuration under
       # Google::Cloud if haven't already
       unless Google::Cloud.configure.option? :logging
-        Google::Cloud.configure.add_nested logging: {
+        Google::Cloud.configure.add_options logging: {
           monitored_resource: :labels
         }
       end
diff --git a/google-cloud-trace/lib/google/cloud/trace.rb b/google-cloud-trace/lib/google/cloud/trace.rb
@@ -194,7 +194,7 @@ module Trace
       # Initialize :error_reporting as a nested Configuration under
       # Google::Cloud if haven't already
       unless Google::Cloud.configure.option? :trace
-        Google::Cloud.configure.add_nested :trace
+        Google::Cloud.configure.add_options :trace
       end
 
       ##
diff --git a/stackdriver-core/lib/stackdriver/core/configuration.rb b/stackdriver-core/lib/stackdriver/core/configuration.rb
@@ -18,55 +18,55 @@ module Core
     ##
     # @private Helps organize configuration options for Stackdriver
     # instrumentation libraries. It's initialized with a nested list of
-    # predefined option keys, then only allows getting and setting these
+    # predefined category keys, then only allows getting and setting these
     # predefined options.
     #
     # @example
-    #   nested_categories = [:nested1, {nested2: [:nested3]}]
-    #   config = Stackdriver::Core::Configuration.new nested: nested_categories
+    #   nested_categories = [:cat1, {cat2: [:cat3]}]
+    #   config = Stackdriver::Core::Configuration.new nested_categories
     #
     #   config.opt1        #=> nil
     #   config.opt1 = true #=> true
     #   config.opt1        #=> true
     #
-    #   config.nested1           #=> <Stackdriver::Core::Configuration>
-    #   config.nested2.nested3   #=> <Stackdriver::Core::Configuration>
+    #   config.cat1           #=> <Stackdriver::Core::Configuration>
+    #   config.cat2.cat3   #=> <Stackdriver::Core::Configuration>
     #
     class Configuration < Hash
       ##
       # Constructs a new instance of Configuration object.
       #
-      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>] nested
-      #   A Symbol, or nested Array and Hash of sub configuration categories.
-      #   A single symbol, or symbols in array, will be key(s) to next level of
-      #   categories. Nested hash represent sub categories with further nested
-      #   sub categories.
+      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>]
+      #   categories A Symbol, or nested Array and Hash of sub configuration
+      #   categories. A single symbol, or symbols in array, will be key(s) to
+      #   next level of categories. Nested hash represent sub categories with
+      #   further nested sub categories.
       #
-      def initialize nested = {}
+      def initialize categories = {}
         super()
 
-        add_nested nested
+        add_options categories
       end
 
       ##
-      # Add nested sub configurations to a Configuration object
+      # Add nested sub configuration categories to a Configuration object
       #
-      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>] nested
-      #   A Symbol, or nested Array and Hash of sub configuration categories.
-      #   A single symbol, or symbols in array, will be key(s) to next level of
-      #   categories. Nested hash represent sub categories with further nested
-      #   sub categories.
+      # @param [Symbol, Array<Symbol, Hash>, Hash<Symbol, (Array, Hash)>]
+      #   categories A Symbol, or nested Array and Hash of sub configuration
+      #   categories. A single symbol, or symbols in array, will be key(s) to
+      #   next level of categories. Nested hash represent sub categories with
+      #   further nested sub categories.
       #
       # @example
       #   config = Stackdriver::Core::Configuration.new
-      #   config.nest1 #=> nil
-      #   config.add_nested {nest1: [nest2]}
-      #   config.nest1 #=> <Stackdriver::Core::Configuration>
-      #   config.nest1.nest2 #=> <Stackdriver::Core::Configuration>
+      #   config.cat1 #=> nil
+      #   config.add_options {cat1: [:cat2]}
+      #   config.cat1 #=> <Stackdriver::Core::Configuration>
+      #   config.cat1.cat2 #=> <Stackdriver::Core::Configuration>
       #
-      def add_nested nested
-        nested = [nested].flatten(1)
-        nested.each do |sub_key|
+      def add_options categories
+        categories = [categories].flatten(1)
+        categories.each do |sub_key|
           case sub_key
           when Symbol
             self[sub_key] = self.class.new
diff --git a/stackdriver-core/test/stackdriver/core/configuration_test.rb b/stackdriver-core/test/stackdriver/core/configuration_test.rb
@@ -53,11 +53,11 @@
     end
   end
 
-  describe "#add_nested" do
+  describe "#add_options" do
     it "introduces new nested categories" do
       configuration.k4.must_be_nil
 
-      configuration.add_nested [:k4, {k5: [:k6]}]
+      configuration.add_options [:k4, {k5: [:k6]}]
 
       configuration.k4.must_be_kind_of Stackdriver::Core::Configuration
       configuration.k5.must_be_kind_of Stackdriver::Core::Configuration
@@ -67,7 +67,7 @@
     it "accepts simple hash with one symbol" do
       configuration.k4.must_be_nil
 
-      configuration.add_nested k4: :k5
+      configuration.add_options k4: :k5
 
       configuration.k4.must_be_kind_of Stackdriver::Core::Configuration
       configuration.k4.k5.must_be_kind_of Stackdriver::Core::Configuration

Original file line number	Diff line number	Diff line change
`@@ -332,7 +332,7 @@ module Logging`
`332`	`332`	`# Initialize :error_reporting as a nested Configuration under`
`333`	`333`	`# Google::Cloud if haven't already`
`334`	`334`	`unless Google::Cloud.configure.option? :logging`
`335`		`- Google::Cloud.configure.add_nested logging: {`
	`335`	`+ Google::Cloud.configure.add_options logging: {`
`336`	`336`	`monitored_resource: :labels`
`337`	`337`	`}`
`338`	`338`	`end`