cloudenvoy 0.4.2 → 0.6.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41639ae4ee8dd10d46e88233f3a4ceb028968e01f5b173fd798cfffe19ae0b48
-  data.tar.gz: 311ca0ebb0dd52abc523ffe351b5916bed9794ebb2ce2246bc8d517220f3b539
+  metadata.gz: cb4f27d4f01e971d8542f5768166caa9d797ad9799372bf167ddfe5e970ecb51
+  data.tar.gz: 5f2ed34bde0799fc94d574203f4589ede66b90da39a4f8e9bf4b6a8b41fac483
 SHA512:
-  metadata.gz: a7a8cf4f967e6a63e03878ab8656e20598cdfba01de979b4daeb82b500bbc5a92eb3a424fd6c7893f60e69e14028bd25d78d6780c2485f1362d1551de30ef6d9
-  data.tar.gz: f25628e0693c6fa7d1cfaedcff7a0fe3085af7a30bb8186dfa9e7af919c08300bb755ae6e75ffaaa545623a63e8a76f8b0fda8d9968eef05ced0a3fa23f96cb1
+  metadata.gz: 6a71d84e06873d76352df8ccef0ee32f95a439e62447bf90e2a57694816753337186b6f57ad9864911d8bfec270eff31b8ccd0183c36f894ce030cd1b5c6ccb8
+  data.tar.gz: ac0be67ec3bc95c2b9cc32745dcbd72c87fcd06cf329dbf007cde92139b8c70a712545afc7e69bb44bd61397641989e1af7f8ff41bdeb82efe5400ca84993a58

data/.github/workflows/lint_rubocop.yml

@@ -0,0 +1,20 @@
+name: Rubocop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0.1'
+          bundler-cache: true
+      - name: Lint codebase
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop

data/.github/workflows/{test.yml → test_ruby_2.5_2.6.yml}

@@ -1,10 +1,6 @@
-name: Test
+name: Ruby 2.5/2.6
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -12,30 +8,29 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.5.x'
-          - '2.6.x'
+          - '2.5.9'
+          - '2.6.7'
         appraisal:
           - 'rails-5.2'
           - 'rails-6.0'
+          - 'rails-6.1'
           - 'semantic_logger-3.4'
           - 'semantic_logger-4.6'
           - 'semantic_logger-4.7.0'
           - 'semantic_logger-4.7.2'
     steps:
-      - name: Setup System
-        run: sudo apt-get install libsqlite3-dev
       - uses: actions/checkout@v2
       - uses: zhulik/redis-action@1.1.0
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Build and test with Rake
         env:
             APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-          bundle exec rubocop
           bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
           bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_2.7.yml

@@ -0,0 +1,36 @@
+name: Ruby 2.7
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '2.7.5'
+        appraisal:
+          - 'rails-5.2'
+          - 'rails-6.0'
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.github/workflows/test_ruby_3.x.yml

@@ -0,0 +1,35 @@
+name: Ruby 3.x
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - '3.0.1'
+          # - '3.1.0'
+        appraisal:
+          - 'rails-6.1'
+          - 'rails-7.0'
+          - 'semantic_logger-3.4'
+          - 'semantic_logger-4.6'
+          - 'semantic_logger-4.7.0'
+          - 'semantic_logger-4.7.2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: zhulik/redis-action@1.1.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Build and test with Rake
+        env:
+            APPRAISAL_CONTEXT: ${{ matrix.appraisal }}
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec appraisal ${APPRAISAL_CONTEXT} bundle
+          bundle exec appraisal ${APPRAISAL_CONTEXT} rspec

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /examples/rails/log/*.log
 /examples/rails/tmp/
+/gemfiles/*.gemfile.lock
 /pkg/
 /spec/reports/
 /tmp/

data/.rubocop.yml

@@ -1,10 +1,14 @@
 require: rubocop-rspec
 
 AllCops:
+  NewCops: enable
   Exclude:
     - 'gemfiles/**/*'
     - 'vendor/**/*'
 
+Layout/LineLength:
+  Max: 160
+
 Metrics/ClassLength:
   Max: 150
 
@@ -12,14 +16,20 @@ Metrics/ModuleLength:
   Max: 150
 
 Metrics/AbcSize:
-  Max: 20
-
-Metrics/LineLength:
-  Max: 120
+  Max: 30
 
 Metrics/MethodLength:
   Max: 20
 
+Metrics/BlockLength:
+  Exclude:
+    - cloudenvoy.gemspec
+    - lib/tasks/**/*
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 RSpec/ExpectInHook:
   Enabled: false
 
@@ -29,19 +39,10 @@ RSpec/EmptyLineAfterHook:
 RSpec/ScatteredSetup:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - cloudenvoy.gemspec
-    - lib/tasks/**/*
-    - 'spec/**/*'
+RSpec/MessageSpies:
+  Enabled: false
 
 Style/Documentation:
   Exclude:
     - 'examples/**/*'
-    - 'spec/**/*'
-
-Metrics/ParameterLists:
-  CountKeywordArgs: false
-
-RSpec/MessageSpies:
-  Enabled: false
+    - 'spec/**/*'

data/Appraisals

@@ -1,25 +1,45 @@
 # frozen_string_literal: true
 
-appraise 'rails-5.2' do
-  gem 'rails', '5.2'
+if RUBY_VERSION < '3'
+  appraise 'rails-5.2' do
+    gem 'rails', '5.2'
+    gem 'rspec-rails'
+  end
+
+  appraise 'rails-6.0' do
+    gem 'rails', '6.0'
+    gem 'rspec-rails'
+  end
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '6.1'
+  gem 'rspec-rails'
 end
 
-appraise 'rails-6.0' do
-  gem 'rails', '6.0'
+if RUBY_VERSION >= '2.7'
+  appraise 'rails-7.0' do
+    gem 'rails', '7.0'
+    gem 'rspec-rails'
+  end
 end
 
 appraise 'semantic_logger-3.4' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '3.4.1'
 end
 
 appraise 'semantic_logger-4.6' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.6.1'
 end
 
 appraise 'semantic_logger-4.7.0' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.0'
 end
 
 appraise 'semantic_logger-4.7.2' do
+  gem 'activesupport', '6.1' # ruby 2.5 / 2.6 compatibility
   gem 'semantic_logger', '4.7.2'
 end

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [v0.6.rc1](https://github.com/keypup-io/cloudenvoy/tree/v0.6.rc1) (2022-04-11)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.5.0...v0.6.rc1)
+
+**Improvements:**
+- Pub/sub: Add `publish_all` method to publish multiple messages in one batch
+- Ruby: Drop support for Ruby `2.3`
+- Style: Upgrade rubocop to `0.93.0`
+
+## [v0.5.0](https://github.com/keypup-io/cloudenvoy/tree/v0.5.0) (2022-03-11)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.2...v0.5.0)
+
+**Improvements:**
+- Ruby 3: Rework method arguments to be compatible with Ruby 3
+- Tests: Separate test environment for Ruby 2 and Ruby 3
+- Tests: Do not load Rails by default and skip Rails-specific tests in non-Rails appraisals
+
 ## [v0.4.2](https://github.com/keypup-io/cloudenvoy/tree/v0.4.2) (2021-10-25)
 
 [Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.4.1...v0.4.2)

data/README.md

@@ -133,7 +133,12 @@ rails s -p 3000
 
 Open a Rails console and send a message
 ```ruby
+  # One message at a time
   DummyPublisher.publish('Hello pub/sub')
+
+  # Publish multiple messages in one batch
+  # Only available since v0.6.rc1
+  DummyPublisher.publish_all(['Hello pub/sub', 'Hello again!', 'Hello again and again!'])
 ```
 
 Your Rails logs should display the following:
@@ -249,10 +254,21 @@ DummySubscriber.setup
 ## Publishing messages
 
 ### Sending messages
+**Note**: The `publish_all` method is only available since `v0.6.rc1`
 
 Cloudenvoy provides a helper method to publish arbitrary messages to any topic.
 ```ruby
+# Publish a single message
 Cloudenvoy.publish('my-topic', { 'some' => 'payload' }, { 'optional' => 'message attribute' })
+
+# Publish multiple messages in one batch
+# Only available since v0.6.rc1
+Cloudenvoy.publish_all('my-topic', [
+  # Message 1
+  [{ 'some' => 'msg1 payload' }, { 'optional' => 'msg1 attribute' }],
+  # Message 2
+  [{ 'some' => 'msg2 payload' }, { 'optional' => 'msg2 attribute' }]
+])
 ```
 
 This helper is useful for sending basic messages however it is not the preferred way of sending messages as you will quickly clutter your application with message formatting logic over time.
@@ -289,8 +305,21 @@ Then in your user model you can do the following:
 class User < ApplicationRecord
   after_create :publish_user
 
+  # Example: publish multiple messages in one batch
+  # Only available since v0.6.rc1
+  # 
+  #
+  # Set user status to 'active' without involving callbacks
+  # then manually publish the new state of users in one batch
+  def self.enable_all_users
+    User.update_all(status: 'active', updated_at: Time.current)
+    UserPublisher.publish_all(User.all)
+  end
+
   private
 
+  # Example: publish one message at a time
+  #
   # Publish users after they have been created
   def publish_user
     UserPublisher.publish(self)
@@ -601,9 +630,17 @@ end
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+For tests, run `rake` to run the tests. Note that Rails is not in context by default, which means Rails-specific test will not run.
+For tests including Rails-specific tests, run `bundle exec appraisal rails-7.0 rake`
+For all context-specific tests (incl. Rails), run the [appraisal tests](Appraisals) using `bundle exec appraisal rake`.
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/cloudenvoy.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Cross-application messaging using GCP Pub/Sub (alpha)'
   spec.homepage      = 'https://github.com/keypup-io/cloudenvoy'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/keypup-io/cloudenvoy'
@@ -35,13 +35,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.76.0'
+  spec.add_development_dependency 'rubocop', '0.93.0'
   spec.add_development_dependency 'rubocop-rspec', '1.37.0'
   spec.add_development_dependency 'semantic_logger'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock'
-
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'sqlite3'
 end

data/examples/rails/.ruby-version

@@ -1 +1 @@
-ruby-2.5.5
+ruby-3.0.0

data/examples/rails/Gemfile

@@ -3,11 +3,14 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.5.5'
+ruby '3.0.0'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0.2'
 
+# Server
+gem 'puma', '~> 5.6.4'
+
 # Messaging via GCP Pub/Sub
 gem 'cloudenvoy', path: '../../'