publishing_platform_app_config 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea7eb6a338b040aba9272faf3130d42aed758692158ef9a010bf038e5b887ef4
-  data.tar.gz: 599d4301e0865e826df615ec3f715a326f95bd1bfc5588f6fe2d33cd363b606b
+  metadata.gz: 4b2e3bc5b89e3b4a47cf69d695c6dc61d83b10efa3209be95a7903aa7f9e96e1
+  data.tar.gz: 8a92dff954b7338cb787cec741c1ade155c71b0ebaa65720e59f81865192c3ac
 SHA512:
-  metadata.gz: db2c14514990234c81df6dd6728d3281402401125c51f2328218b98cb50c06c049dac67a968f25f6f0ee52cebae21d2158d7f9d26fb99d3da6a0452077d422e7
-  data.tar.gz: d1fe89fb6a497fff2a5abdb181edb40633dc1467c11e85a610e3a4957b311281118068f948fb17355a1c8a3ee891c15e4ad3a45729302dae810ac01b63f90bcd
+  metadata.gz: 49197ae21a0e92c4c1bcdac435890ee3104f952c14819369678427fa65155b3d8add5205a7bad6e1ccd0c5b6c41d75f9eff3e7c9fe78f2ea0b78af0c4d7a0cb0
+  data.tar.gz: 57fb61a4adac41174e0ba782f6e187b4100eba3d4ffee378f4b3551724efd161054e3620065cd9b4b99341060e784b9a36ad51497c45ee06dcc658901d3d43e1

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:  
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.2, 3.3]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: publishing-platform/publishing-platform-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.PUBLISHING_PLATFORM_RUBYGEMS_API_KEY }}      

data/.ruby-version

@@ -0,0 +1 @@
+3.2.4

data/Rakefile

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/publishing_platform_app_config/publishing_platform_error.rb

@@ -34,7 +34,7 @@ module PublishingPlatformError
     raise PublishingPlatformError::AlreadyInitialised if is_configured?
 
     if defined?(Sidekiq) && !defined?(Sentry::Sidekiq)
-      warn "Warning: PublishingPlatformAppConfig is not configured to track Sidekiq errors, install the sentry-sidekiq gem to track them."
+      warn "Warning: PublishingPlatformError is not configured to track Sidekiq errors, install the sentry-sidekiq gem to track them."
     end
 
     Sentry.init do |sentry_config|

data/lib/publishing_platform_app_config/publishing_platform_puma.rb

@@ -0,0 +1,31 @@
+module PublishingPlatformPuma
+  def self.configure_rails(config)
+    config.port ENV.fetch("PORT", 3000)
+
+    config.environment ENV.fetch("RAILS_ENV", "development")
+
+    # `worker_timeout` specifies how many seconds Puma will wait before terminating a worker.
+    timeout = if ENV.fetch("RAILS_ENV", "development") == "development"
+                3600
+              else
+                Integer(ENV.fetch("PUMA_TIMEOUT", 15))
+              end
+    config.worker_timeout timeout
+
+    # When changing the min/max threads for Puma, also consider changing ActiveRecord to match.
+    max_threads_count = ENV.fetch("RAILS_MAX_THREADS", 5)
+    min_threads_count = ENV.fetch("RAILS_MIN_THREADS", max_threads_count)
+    config.threads min_threads_count, max_threads_count
+
+    # `workers` specifies the number of worker processes that Puma will fork.
+    # The overall concurrency limit is worker count * max threads per worker.
+    config.workers ENV.fetch("WEB_CONCURRENCY", 2)
+
+    # `preload_app!` tells Puma to load application code before forking worker processes.
+    # This reduces RAM wastage by making better use of copy-on-write.
+    config.preload_app!
+
+    # Allow puma to be restarted by `rails restart` command.
+    config.plugin :tmp_restart
+  end
+end

data/lib/publishing_platform_app_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PublishingPlatformAppConfig
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/publishing_platform_app_config.gemspec

@@ -10,15 +10,19 @@ Gem::Specification.new do |spec|
   spec.summary = "Base configuration for Publishing Platform applications"
   spec.description = "Base configuration for Publishing Platform applications"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files =  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_dependency "puma", ">= 5.6", "< 7.0"
   spec.add_dependency "sentry-rails", "~> 5.3"
   spec.add_dependency "sentry-ruby", "~> 5.3"
 
+  spec.add_development_dependency "climate_control"
   spec.add_development_dependency "publishing_platform_rubocop"
+  spec.add_development_dependency "rails", "~> 7"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,15 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: publishing_platform_app_config
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Publishing Platform
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sentry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +57,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: publishing_platform_rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -52,16 +85,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Base configuration for Publishing Platform applications
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -72,14 +134,13 @@ files:
 - lib/publishing_platform_app_config/publishing_platform_content_security_policy.rb
 - lib/publishing_platform_app_config/publishing_platform_error.rb
 - lib/publishing_platform_app_config/publishing_platform_error/configuration.rb
+- lib/publishing_platform_app_config/publishing_platform_puma.rb
 - lib/publishing_platform_app_config/railtie.rb
 - lib/publishing_platform_app_config/version.rb
 - publishing_platform_app_config.gemspec
-homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Base configuration for Publishing Platform applications
 test_files: []

data/.github/workflows/main.yml

@@ -1,27 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - master
-
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby:
-          - '3.1.2'
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake