rails_database_await 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab25417a8d7f0460b7309d17e44a5118681f9d38e6b595ff25e95b34ea8adb4b
+  data.tar.gz: f9001704cd318349fa8f9b6835059f3a35b84852ad876dfe9e3e74c22e58fc74
+SHA512:
+  metadata.gz: 47fd4eb74da635b165841e3b0543e10e399ab1c14339bd088ff8228c990bb768357217b235585f3becdd4e00ba33538045a5728ee79012337ff4e41e1fd5196d
+  data.tar.gz: 69748ece0d638b938e612a4df81a956824bee6ed232abc5ef9da8828a8192002ac88fa41fd02099a5246200a3bee829035c8aa29109c29589f69a3085cb3f0b7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-07
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Micke Lisinge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# RailsDatabaseAwait
+
+This gem was created to solve the problem when you might have to wait until the database is ready before continuing.
+For example when running migrations in a kubernetes job while using Google Cloud SQL Auth Proxy as a sidecar.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rails_database_await
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rails_database_await
+
+## Usage
+
+`bundle exec rails db:await`
+
+Configure the number of times we should be trying to connect to the database by setting the `DATABASE_AWAIT_MAX_TRIES` (Defaults to 30).
+Configure the number of seconds to wait between each time we try to connect to the database by setting the `DATABASE_AWAIT_WAIT_TIME` (Defaults to 1).
+
+For example; To wait for the database to be ready before running migrations we can just do:
+
+`bundle exec rails db:await db:migrate`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apoex/rails_database_await.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/rails_database_await/railtie.rb

@@ -0,0 +1,13 @@
+require "rails_database_await"
+require "rails"
+
+module RailsDatabaseAwait
+  class Railtie < Rails::Railtie
+    railtie_name :rails_database_await
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      load "#{path}/tasks/db/await.rake"
+    end
+  end
+end

data/lib/rails_database_await/tasks/db/await.rake

@@ -0,0 +1,22 @@
+MAX_TRIES = ENV.fetch("DATABASE_AWAIT_MAX_TRIES", 30).to_i
+WAIT_TIME = ENV.fetch("DATABASE_AWAIT_WAIT_TIME", 1).to_i
+
+namespace :db do
+  task await: :environment do
+    tries ||= 0
+    tries += 1
+
+    ActiveRecord::Base.connection
+    puts "Database available"
+  rescue PG::ConnectionBad, ActiveRecord::ConnectionNotEstablished
+    if tries >= MAX_TRIES
+      puts "#{MAX_TRIES} tries exceeded, exiting"
+      exit 1
+    end
+
+    puts "Database unavailable, waiting #{WAIT_TIME} second. #{MAX_TRIES - tries} tries left."
+
+    sleep WAIT_TIME
+    retry
+  end
+end

data/lib/rails_database_await/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsDatabaseAwait
+  VERSION = "0.1.0"
+end

data/lib/rails_database_await.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "rails_database_await/version"
+require_relative "rails_database_await/railtie" if defined?(Rails)
+
+module RailsDatabaseAwait
+end

data/sig/rails_database_await.rbs

@@ -0,0 +1,4 @@
+module RailsDatabaseAwait
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails_database_await
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ApoEx
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Await readiness of database, when using Google Cloud SQL Auth Proxy for
+  example.
+email:
+- tech-lead@apoex.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_database_await.rb
+- lib/rails_database_await/railtie.rb
+- lib/rails_database_await/tasks/db/await.rake
+- lib/rails_database_await/version.rb
+- sig/rails_database_await.rbs
+homepage: https://github.com/apoex/rails_database_await
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/apoex/rails_database_await
+  source_code_uri: https://github.com/apoex/rails_database_await
+  changelog_uri: https://github.com/apoex/rails_database_await
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Await readiness of database, when using Google Cloud SQL Auth Proxy for example.
+test_files: []