stackdriver-core 1.3.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ca3e89369f51c4d2d815943888e068953d9bed387ab4576f05b307e3f344df4
-  data.tar.gz: 28f34466ca670a0e3bc7984986f88794ea281ca19d6ee5d8c247ca803ba54ff2
+  metadata.gz: 8f81fa2a5e8d9aba8eb544fcc103f6f1799cbf1a7d5a5025200012f0aeb5475e
+  data.tar.gz: ad2b549b3200b8dfa0ef9579f3d99fbb75511511891142b58f33e0f4b453c11f
 SHA512:
-  metadata.gz: c4db8f3e2f2d26836ee16daa11455fdf5298ba742aa138fd9a45776245ef028b94e502dddc36d9986b2c74a489f7cb27bae7a8a6bf942d2b601fac4e5e927871
-  data.tar.gz: ae5314aa0a31b88f4dce10502928416d2600cd2136b75b81ba6b162ffe49ca5ff68eec3f5156b396ee0ad014905df266de94429e53049f67f2488121324f9043
+  metadata.gz: 248825ab9ac8dfc4b6978c8f88d4899a73776ec0fbd286149f9ba920356090d8979e4742e51f4ff6fbdaa90a8b8de5bc94eced98b6eb49b2bfccb1aba2220026
+  data.tar.gz: ed997287c5c14b88b6be4e304afba83553c8066c937620a05ea0bf308c02c9f2b9b129e04143afd7aca4bdc4f092e97ec395f24ba95f47653d78aa6c0b8107f8

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Release History
+
+### 1.5.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 1.4.0 / 2019-10-23
+
+Now requires Ruby 2.4 or later.
+
+### 1.3.4 / 2019-08-23
+
+#### Documentation
+
+* Update documentation
+
+### 1.3.3 / 2018-09-20
+
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+
+### 1.3.2 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 1.3.1 / 2018-09-10
+
+* Update documentation.
+
+### 1.3.0 / 2018-02-27
+
+* Use Google Cloud Shared Configuration.
+
+### 1.2.0 / 2017-07-11
+
+* Introduce `Stackdriver::Core::AsyncActor` module, used by stackdriver gems to perform asynchronous jobs.
+
+### 1.1.0 / 2017-05-25
+
+* Introduce new Stackdriver instrumentation configuration interface.
+
+### 1.0.0 / 2017-03-31
+
+* Release 1.0
+
+### 0.21.0 / 2016-12-22
+
+* Initial release of shared code for Stackdriver related client libraries.
+* Provided trace context management code.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,128 @@
+# Contributing to Google Cloud Stackdriver
+
+1. **Sign one of the contributor license agreements below.**
+2. Fork the repo, develop and test your code changes.
+3. Send a pull request.
+
+## Contributor License Agreements
+
+Before we can accept your pull requests you'll need to sign a Contributor
+License Agreement (CLA):
+
+- **If you are an individual writing original source code** and **you own the
+  intellectual property**, then you'll need to sign an [individual
+  CLA](https://developers.google.com/open-source/cla/individual).
+- **If you work for a company that wants to allow you to contribute your work**,
+  then you'll need to sign a [corporate
+  CLA](https://developers.google.com/open-source/cla/corporate).
+
+You can sign these electronically (just scroll to the bottom). After that, we'll
+be able to accept your pull requests.
+
+## Setup
+
+In order to use the stackdriver console and run the project's tests,
+there is a small amount of setup:
+
+1. Install Ruby. stackdriver requires Ruby 2.5+. 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/).
+
+   ```sh
+   $ gem install bundler
+   ```
+
+3. Install the top-level project dependencies.
+
+   ```sh
+   $ bundle install
+   ```
+
+4. Install the Stackdriver dependencies.
+
+   ```sh
+   $ cd stackdriver-core/
+   $ bundle install
+   ```
+
+## Stackdriver Tests
+
+Tests are very important part of stackdriver. All contributions
+should include tests that ensure the contributed code behaves as expected.
+
+To run the unit tests, documentation tests, and code style checks together for a
+package:
+
+``` sh
+$ cd stackdriver-core/
+$ bundle exec rake ci
+```
+
+To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
+its handy alias, `rake ci:a`.
+
+### Stackdriver Unit Tests
+
+
+The project uses the [minitest](https://github.com/seattlerb/minitest) library,
+including [specs](https://github.com/seattlerb/minitest#specs),
+[mocks](https://github.com/seattlerb/minitest#mocks) and
+[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
+
+To run the Stackdriver unit tests:
+
+``` sh
+$ cd stackdriver-core/
+$ bundle exec rake test
+```
+
+### Stackdriver Documentation Tests
+
+The project tests the code examples in the gem's
+[YARD](https://github.com/lsegal/yard)-based documentation.
+
+The example testing functions in a way that is very similar to unit testing, and
+in fact the library providing it,
+[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
+project's unit test library, [minitest](https://github.com/seattlerb/minitest).
+
+To run the Stackdriver documentation tests:
+
+``` sh
+$ cd stackdriver-core/
+$ bundle exec rake doctest
+```
+
+If you add, remove or modify documentation examples when working on a pull
+request, you may need to update the setup for the tests. The stubs and mocks
+required to run the tests are located in `support/doctest_helper.rb`. Please
+note that much of the setup is matched by the title of the
+[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
+If you alter an example's title, you may encounter breaking tests.
+
+## Coding Style
+
+Please follow the established coding style in the library. The style is is
+largely based on [The Ruby Style
+Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
+on seattle-style:
+
+* Avoid parenthesis when possible, including in method definitions.
+* Always use double quotes strings. ([Option
+  B](https://github.com/bbatsov/ruby-style-guide#strings))
+
+You can check your code against these rules by running Rubocop like so:
+
+```sh
+$ cd stackdriver-core/
+$ 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.

data/OVERVIEW.md

@@ -0,0 +1,5 @@
+# Stackdriver Core
+
+The {Stackdriver::Core} module is a namespace for common types and shared
+utilities used by the Google Stackdriver libraries. Most applications will not
+need to use these classes directly.

data/lib/stackdriver/core.rb

@@ -15,7 +15,6 @@
 
 require "stackdriver/core/configuration"
 require "stackdriver/core/async_actor"
-require "stackdriver/core/configuration"
 require "stackdriver/core/trace_context"
 require "stackdriver/core/version"
 

data/lib/stackdriver/core/async_actor.rb

@@ -74,12 +74,12 @@ module Stackdriver
       def async_stop
         ensure_thread
         synchronize do
-          if async_state != :stopped
+          if async_state == :stopped
+            false
+          else
             @async_state = :stopping
             async_state_change
             true
-          else
-            false
           end
         end
       end
@@ -189,7 +189,7 @@ module Stackdriver
 
         return :stopped unless async_stop
 
-        return :waited if timeout.to_f > 0 && wait_until_async_stopped(timeout)
+        return :waited if timeout.to_f.positive? && wait_until_async_stopped(timeout)
 
         return :timeout unless force
 
@@ -249,7 +249,7 @@ module Stackdriver
       #
       def self.unregister_for_cleanup actor
         @exit_lock.synchronize do
-          @cleanup_list.delete actor if @cleanup_list
+          @cleanup_list&.delete actor
         end
       end
 
@@ -258,9 +258,8 @@ module Stackdriver
       #
       def self.run_cleanup
         @exit_lock.synchronize do
-          if @cleanup_list
-            @cleanup_list.shift.async_stop! until @cleanup_list.empty?
-          end
+          return unless @cleanup_list
+          @cleanup_list.shift.async_stop! until @cleanup_list.empty?
         end
       end
 
@@ -276,8 +275,8 @@ module Stackdriver
         @startup_lock = Mutex.new
         @cleanup_options = {
           wait_interval: WAIT_INTERVAL,
-          timeout: CLEANUP_TIMEOUT,
-          force: true
+          timeout:       CLEANUP_TIMEOUT,
+          force:         true
         }
       end
 
@@ -352,7 +351,8 @@ module Stackdriver
       # @private Default abstract definition of this function that's a no-op.
       # The extending classes can override this method to handle state changing
       # logic.
-      def on_async_state_change; end
+      def on_async_state_change
+      end
     end
   end
 end

data/lib/stackdriver/core/trace_context.rb

@@ -335,7 +335,7 @@ module Stackdriver
         val = rand 0x100000000000000000000000000000000
         val &= 0xffffffffffff0fffcfffffffffffffff
         val |= 0x00000000000040008000000000000000
-        format("%032x", val)
+        format "%032x", val
       end
     end
   end

data/lib/stackdriver/core/version.rb

@@ -15,6 +15,6 @@
 
 module Stackdriver
   module Core
-    VERSION = "1.3.1".freeze
+    VERSION = "1.5.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackdriver-core
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -25,63 +25,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: autotest-suffix
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: autotest-suffix
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -173,15 +173,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
-- README.md
+- OVERVIEW.md
 - lib/stackdriver-core.rb
 - lib/stackdriver/core.rb
 - lib/stackdriver/core/async_actor.rb
 - lib/stackdriver/core/configuration.rb
 - lib/stackdriver/core/trace_context.rb
 - lib/stackdriver/core/version.rb
-homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/stackdriver-core
+homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/stackdriver-core
 licenses:
 - Apache-2.0
 metadata: {}
@@ -193,15 +196,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: Internal shared library for Ruby Stackdriver integration

data/README.md

@@ -1,52 +0,0 @@
-# stackdriver-core
-
-This library contains shared types and utilities for Stackdriver-related
-libraries. Please see the [GitHub
-repository](https://github.com/GoogleCloudPlatform/google-cloud-ruby) for more
-information about the individual google-cloud gems.
-
-- [stackdriver-core API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest)
-
-## Supported Ruby Versions
-
-This library is supported on Ruby 2.3+.
-
-Google provides official support for Ruby versions that are actively supported
-by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
-security maintenance, and not end of life. Currently, this means Ruby 2.3 and
-later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
-
-## Versioning
-
-This library follows [Semantic Versioning](http://semver.org/).
-
-It is currently in major version zero (0.y.z), which means that anything may
-change at any time and the public API should not be considered stable.
-
-## Contributing
-
-Contributions to this library are always welcome and highly encouraged.
-
-See the [Contributing
-Guide](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.CONTRIBUTING)
-for more information on how to get started.
-
-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 [Code of
-Conduct](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.CODE_OF_CONDUCT)
-for more information.
-
-## License
-
-This library is licensed under Apache 2.0. Full license text is available in
-[LICENSE](http://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver-core/latest/file.LICENSE).
-
-## Support
-
-Please [report bugs at the project on
-Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
-hesitate to [ask
-questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
-about the client or APIs on [StackOverflow](http://stackoverflow.com).