google-cloud-debugger 0.40.0 → 0.42.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4ce08aa3118de8cc2a1afe7874ca26f6d97a7922f84471caef85fe0aed3640
-  data.tar.gz: a6bc54a758686120fe5898e69179994e3325e72adf5c9e3b8ef4b0b010a5c9d6
+  metadata.gz: 2d4b08e7a1f34cc84bf9d7c614d749e7bc1dee4ab2fa334120703c95b1ff2576
+  data.tar.gz: d48b399e55c3fcad4120fc546074d192d17f4bc75545fd63e06874c0f9a35533
 SHA512:
-  metadata.gz: 150edcd3b7d9c16480900ac16d22925eaf08c1629ac40c601d308da5e3db74237dbacd6510c9357861650d8fe519239c53c361448e3f6d005058313c1e442909
-  data.tar.gz: ce89d0b2545e87b7587b8887a6eafe1dead96614616437ce2709f60a83780a38607990687caf74398a219093d019f68bcd615aac469e1b35efec732c71141508
+  metadata.gz: ee34e243d7631e421065982d6d444b31400031708cd77be57daffdfe9693f682e5d8c4a1432dde1f2a6c2ce324adfefc444b8f2401d7fe9da0f75b70180440c0
+  data.tar.gz: e551a48d39f8a689667a7c8f6e6ac25f937759cc6a1ee2963a7cab91ac690d030449da7c1195f18bf8abb6372cc4bad1ad44bcda1149ff8fce42789253b174f5

data/AUTHENTICATION.md

@@ -96,7 +96,8 @@ client = Google::Cloud::Debugger.new
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Project ID** and the path to the **Credentials JSON** file can be configured
+instead of placing them in environment variables or providing them as arguments.
 
 ```ruby
 require "google/cloud/debugger"

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Release History
 
+### 0.42.2 / 2021-10-21
+
+#### Documentation
+
+* Add documentation for quota_project Configuration attribute
+
+### 0.42.1 / 2021-07-08
+
+#### Documentation
+
+* Update AUTHENTICATION.md in handwritten packages
+
+### 0.42.0 / 2021-03-31
+
+#### Features
+
+* Drop support for Ruby 2.4 and note that Ruby 3.0 is also unsupported
+
+### 0.41.0 / 2020-09-16
+
+#### Features
+
+* quota_project can be set via library configuration
+
 ### 0.40.0 / 2020-07-21
 
 This is a major update that removes the "low-level" client interface code, and

data/CONTRIBUTING.md

@@ -24,9 +24,9 @@ be able to accept your pull requests.
 In order to use the google-cloud-debugger console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-debugger requires Ruby 2.4+. You may choose to
-   manage your Ruby and gem installations with [RVM](https://rvm.io/),
-   [rbenv](https://github.com/rbenv/rbenv), or
+1. Install Ruby. google-cloud-debugger requires Ruby 2.5+. It is not currently
+   supported on Ruby 3. You may choose to manage your Ruby and gem installations
+   with [RVM](https://rvm.io/), [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
 
 2. Install [Bundler](http://bundler.io/).
@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-debugger/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Console
@@ -119,7 +119,7 @@ If you alter an example's title, you may encounter breaking tests.
 ### Debugger Acceptance Tests
 
 The Debugger acceptance tests interact with the live service API. Follow the
-instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
 the Debugger API. Occasionally, some API features may not yet be generally
 available, making it difficult for some contributors to successfully run the
 entire acceptance test suite. However, please ensure that you do successfully
@@ -184,5 +184,4 @@ $ bundle exec rake rubocop
 ## Code of Conduct
 
 Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See
-{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
+participating in this project you agree to abide by its terms. See {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

data/lib/google/cloud/debugger/agent.rb

@@ -120,7 +120,10 @@ module Google
         # @param [String] app_root Absolute path to the root directory of
         #   the debuggee application. Default to Rack root.
         #
-        def initialize service, logger: nil, service_name:, service_version:,
+        def initialize service,
+                       service_name:,
+                       service_version:,
+                       logger: nil,
                        app_root: nil
           super()
 

data/lib/google/cloud/debugger/breakpoint/evaluator.rb

@@ -849,20 +849,18 @@ module Google
             # do evaluation in a new thread, where function calls can be
             # traced.
             thr = Thread.new do
-              begin
-                Thread.current.thread_variable_set EVALUATOR_REFERENCE, self
-                binding.eval wrap_expression(expression)
-              rescue StandardError, EvaluationError => e
-                # Treat all StandardError as mutation and set @mutation_cause
-                unless e.instance_variable_get :@mutation_cause
-                  e.instance_variable_set(
-                    :@mutation_cause,
-                    Google::Cloud::Debugger::EvaluationError::UNKNOWN_CAUSE
-                  )
-                end
-
-                e
+              Thread.current.thread_variable_set EVALUATOR_REFERENCE, self
+              binding.eval wrap_expression(expression)
+            rescue StandardError, EvaluationError => e
+              # Treat all StandardError as mutation and set @mutation_cause
+              unless e.instance_variable_get :@mutation_cause
+                e.instance_variable_set(
+                  :@mutation_cause,
+                  Google::Cloud::Debugger::EvaluationError::UNKNOWN_CAUSE
+                )
               end
+
+              e
             end
 
             thr.join @time_limit
@@ -942,7 +940,7 @@ module Google
           ##
           # @private Wraps expression with tracing code
           def wrap_expression expression
-            """
+            <<~CODE
               begin
                 ::Google::Cloud::Debugger::Breakpoint::Evaluator.send(
                   :enable_method_trace_for_thread)
@@ -951,11 +949,9 @@ module Google
                 ::Google::Cloud::Debugger::Breakpoint::Evaluator.send(
                   :disable_method_trace_for_thread)
               end
-            """
+            CODE
           end
 
-          # rubocop:disable Layout/RescueEnsureAlignment
-
           ##
           # @private Evaluation tracing callback function. This is called
           # everytime a Ruby function is called during evaluation of
@@ -994,8 +990,6 @@ module Google
             )
           end
 
-          # rubocop:enable Layout/RescueEnsureAlignment
-
           ##
           # @private Evaluation tracing callback function. This is called
           # everytime a C function is called during evaluation of
@@ -1011,12 +1005,12 @@ module Google
           #
           def trace_c_func_callback receiver, defined_class, mid
             return if @allow_mutating_methods
-            if receiver.is_a?(Class) || receiver.is_a?(Module)
-              invalid_op =
+            invalid_op =
+              if receiver.is_a?(Class) || receiver.is_a?(Module)
                 !validate_c_class_method(defined_class, receiver, mid)
-            else
-              invalid_op = !validate_c_instance_method(defined_class, mid)
-            end
+              else
+                !validate_c_instance_method(defined_class, mid)
+              end
 
             return unless invalid_op
 

data/lib/google/cloud/debugger/breakpoint/source_location.rb

@@ -37,7 +37,8 @@ module Google
 
           ##
           # @private Create an empty SourceLocation object.
-          def initialize; end
+          def initialize
+          end
 
           ##
           # @private New Google::Cloud::Debugger::Breakpoint::SourceLocation
@@ -53,8 +54,7 @@ module Google
           ##
           # @private Determines if the SourceLocation has any data.
           def empty?
-            path.nil? &&
-              line.nil?
+            path.nil? && line.nil?
           end
 
           ##

data/lib/google/cloud/debugger/breakpoint/variable.rb

@@ -244,7 +244,7 @@ module Google
 
             # If source is a non-empty Array or Hash, or source has instance
             # variables, evaluate source as a compound variable.
-            if compound_var?(source) && depth > 0
+            if compound_var?(source) && depth.positive?
               from_compound_var source, name: name, depth: depth,
                                         var_table: var_table, limit: limit
             else
@@ -358,9 +358,7 @@ module Google
 
               limit = deduct_limit limit, member_var.total_size
 
-              buffer_full = (limit && limit < 0) ||
-                            i >= MAX_MEMBERS ||
-                            member_var.buffer_full_variable?
+              buffer_full = limit&.negative? || i >= MAX_MEMBERS || member_var.buffer_full_variable?
 
               if buffer_full
                 var.members << Variable.new.tap do |last_var|
@@ -384,8 +382,7 @@ module Google
             new.tap do |var|
               var.name = name if name
 
-              if var_table && var_table.first &&
-                 var_table.first.buffer_full_variable?
+              if var_table&.first&.buffer_full_variable?
                 var.var_table = var_table
                 var.var_table_index = 0
               else

data/lib/google/cloud/debugger/breakpoint/variable_table.rb

@@ -68,7 +68,7 @@ module Google
           # object_id, return the array index if found.
           def rb_var_index rb_var
             variables.each_with_index do |var, i|
-              return i if var.source_var.object_id == rb_var.object_id
+              return i if var.source_var.equal? rb_var
             end
 
             nil

data/lib/google/cloud/debugger/breakpoint.rb

@@ -265,7 +265,7 @@ module Google
         def valid?
           Validator.validate self unless complete?
 
-          status && status.is_error ? false : true
+          status&.is_error ? false : true
         end
 
         ##

data/lib/google/cloud/debugger/middleware.rb

@@ -154,7 +154,7 @@ module Google
           @debugger.agent.tracer.disable_traces_for_thread
 
           # Reset quotas after each request finishes.
-          @debugger.agent.quota_manager.reset if @debugger.agent.quota_manager
+          @debugger.agent.quota_manager&.reset
         end
 
         private

data/lib/google/cloud/debugger/rails.rb

@@ -151,13 +151,13 @@ module Google
               Debugger::Credentials.new credentials
             end
           rescue StandardError => e
-            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
+            $stdout.puts "Note: Google::Cloud::Debugger is disabled because " \
               "it failed to authorize with the service. (#{e.message})"
             return false
           end
 
           if project_id.to_s.empty?
-            STDOUT.puts "Note: Google::Cloud::Debugger is disabled because " \
+            $stdout.puts "Note: Google::Cloud::Debugger is disabled because " \
               "the project ID could not be determined."
             return false
           end

data/lib/google/cloud/debugger/service.rb

@@ -25,7 +25,10 @@ module Google
       # @private Represents the gRPC Debugger service, including all the API
       # methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :host
+        attr_accessor :project
+        attr_accessor :credentials
+        attr_accessor :timeout
+        attr_accessor :host
 
         ##
         # Creates a new Service instance.

data/lib/google/cloud/debugger/snappoint.rb

@@ -33,11 +33,11 @@ module Google
 
         ##
         # Max size of payload a Snappoint collects
-        MAX_PAYLOAD_SIZE = 32768 # 32KB
+        MAX_PAYLOAD_SIZE = 32_768 # 32KB
 
         ##
         # @private Max size an evaluated expression variable is allowed to be
-        MAX_EXPRESSION_LIMIT = 32768 # 32KB
+        MAX_EXPRESSION_LIMIT = 32_768 # 32KB
 
         ##
         # @private Max size a normal evaluated variable is allowed to be
@@ -56,8 +56,7 @@ module Google
         # variable at index 0. This variable will be shared by other variable
         # evaluations if this Snappoint exceeds size limit.
         def init_var_table
-          return if @variable_table[0] &&
-                    @variable_table[0].buffer_full_variable?
+          return if @variable_table[0]&.buffer_full_variable?
 
           buffer_full_var = Variable.buffer_full_variable
           @variable_table.variables.unshift buffer_full_var
@@ -179,11 +178,9 @@ module Google
             end
           end
 
-          result = variable_table.variables.inject result do |sum, var|
+          variable_table.variables.inject result do |sum, var|
             sum + var.payload_size
           end
-
-          result
         end
 
         ##

data/lib/google/cloud/debugger/transmitter.rb

@@ -132,7 +132,7 @@ module Google
         # @return [boolean] `true` when started, `false` otherwise.
         #
         def started?
-          @thread_pool.running? if @thread_pool
+          @thread_pool&.running?
         end
 
         ##

data/lib/google/cloud/debugger/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Debugger
-      VERSION = "0.40.0".freeze
+      VERSION = "0.42.2".freeze
     end
   end
 end

data/lib/google/cloud/debugger.rb

@@ -143,6 +143,8 @@ module Google
       #   absolute file path.
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
+      # * `quota_project` - (String) The project ID for a project that can be
+      #   used by client libraries for quota and billing purposes.
       # * `timeout` - (Integer) Default timeout to use in requests.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.

data/lib/google-cloud-debugger.rb

@@ -173,6 +173,7 @@ Google::Cloud.configure.add_config! :debugger do |config|
   config.add_field! :app_root, nil, match: String
   config.add_field! :root, nil, match: String
   config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
   config.add_field! :endpoint, "clouddebugger.googleapis.com", match: String
   config.add_field! :allow_mutating_methods, false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-debugger
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.42.2
 platform: ruby
 authors:
 - Heng Xiong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -337,16 +337,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client and instrumentation library for Stackdriver Debugger