permadeps 1446.1.3 → 1446.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc250bd5ba2e7653b5389a8591edc0d95026994276bab7d6f8819ada1b2a0be6
-  data.tar.gz: 750e7413ecfaf6a750be7c5862d966dace6b8b3618fa6ccd23764a1acb926eaa
+  metadata.gz: b03699be940d87364b352bc06bad1e4fa1e05fc1117ee7d53df8a707b5751281
+  data.tar.gz: ad0bf6ac5dbfb8eb6a119aa453c97b833f7e7e7ea2ea48605c42b07447129506
 SHA512:
-  metadata.gz: b82feaa7df1a7d26220548f2ed1c92a46cefec39d155f52a9e00172ad7905d70ec02b811c65c98549599a2f4036592188f82448a167314402734a1dcee5d9dfb
-  data.tar.gz: aec0aa392c88b1f31b3f68370a3d807d685818afb4b15792f5665faa56ce371bd61edfb877c44fc6fd3881af2f3237d4bedb9c4af2814d60f5c1c4141d1e3c59
+  metadata.gz: 9ff649e19d3f73ad7d96e27413b6052487f48bbc753f6a4224feaee09641aeee1915060e1c099939be49bdecdfa7921720f60a8365b72c7005c40badcf0c0736
+  data.tar.gz: 557cc71fbcc1bc402e0340a8da6f177bc8815fbd6a3bc59a18c781c096c8a9c7a44be95639c9d20b328196ae373bf19ab04e528567710163cc55db5bcf797384

data/README.md

@@ -1,12 +1,12 @@
 # permadeps
 
-Ruby gem holds my permanent dependencies and configs I'm using in my Rails projects.
+Ruby gem that holds permanent dependencies and configurations for Rails projects.
 
-This gem is compatible with [this](https://github.com/AliOsm/ruby-on-rails-devcontainer) DevContainer setup.
+This gem is compatible with [this Ruby on Rails DevContainer setup](https://github.com/AliOsm/ruby-on-rails-devcontainer).
 
 ## Installation
 
-Install the gem and add it to the Rails application's Gemfile by executing:
+Add the gem to your Rails application's Gemfile by executing:
 
 ```bash
 $ bundle add permadeps
@@ -14,45 +14,49 @@ $ bundle add permadeps
 
 ## Usage
 
-Adding this gem to your Rails project will provide you with the following gems:
-
-### Production dependencies:
-- [`ahoy_matey`](https://github.com/ankane/ahoy) (Will be required)
-- [`better_html`](https://github.com/Shopify/better-html) (Will be required)
-- [`blazer`](https://github.com/ankane/blazer) (Will be required)
-- [`flamegraph`](https://github.com/SamSaffron/flamegraph) (Will be required)
-- [`freezolite`](https://github.com/ruby-next/freezolite)
-- [`geocoder`](https://github.com/alexreisner/geocoder)
-- [`memory_profiler`](https://github.com/SamSaffron/memory_profiler) (Will be required)
-- [`notable`](https://github.com/ankane/notable) (Will be required)
-- [`pghero`](https://github.com/ankane/pghero) (Will be required)
-- [`pg_query`](https://github.com/pganalyze/pg_query)
-- [`rack-mini-profiler`](https://github.com/MiniProfiler/rack-mini-profiler) (Will be required)
-- [`stackprof`](https://github.com/tmm1/stackprof) (Will be required)
-
-### Development dependencies:
-- [`annotaterb`](https://github.com/drwl/annotaterb)
-- [`better_errors`](https://github.com/BetterErrors/better_errors)
-- [`binding_of_caller`](https://github.com/banister/binding_of_caller)
-- [`brakeman`](https://github.com/presidentbeef/brakeman)
-- [`bullet`](https://github.com/flyerhzm/bullet) (Will be required in development environment only)
-- [`bundler-audit`](https://github.com/rubysec/bundler-audit)
-- [`dotenv`](https://github.com/bkeepers/dotenv)
-- [`erb-formatter`](https://github.com/nebulab/erb-formatter)
-- [`erb_lint`](https://github.com/Shopify/erb-lint)
-- [`i18n-tasks`](https://github.com/glebm/i18n-tasks)
-- [`rubocop`](https://github.com/rubocop/rubocop)
-- [`rubocop-minitest`](https://github.com/rubocop/rubocop-minitest)
-- [`rubocop-performance`](https://github.com/rubocop/rubocop-performance)
-- [`rubocop-rails`](https://github.com/rubocop/rubocop-rails)
-- [`rubocop-rake`](https://github.com/rubocop/rubocop-rake)
-- [`rubocop-rspec`](https://github.com/rubocop/rubocop-rspec)
-- [`rubocop-rspec_rails`](https://github.com/rubocop/rubocop-rspec_rails)
-- [`ruby_audit`](https://github.com/civisanalytics/ruby_audit)
-
-#### Rubocop
-
-For `rubocop` gem, use the following configuration file to inherit from `permadeps` gem:
+Adding this gem to your Rails project provides you with the following gems and features:
+
+### Production Dependencies
+
+The following gems will be automatically required:
+
+- [`ahoy_matey`](https://github.com/ankane/ahoy): Analytics for Rails
+- [`better_html`](https://github.com/Shopify/better-html): Better HTML for Rails
+- [`blazer`](https://github.com/ankane/blazer): Business intelligence made simple
+- [`flamegraph`](https://github.com/SamSaffron/flamegraph): Flamegraph profiler
+- [`geocoder`](https://github.com/alexreisner/geocoder): Geocoding solution
+- [`good_job`](https://github.com/bensheldon/good_job): Multithreaded, Postgres-based, Active Job backend
+- [`memory_profiler`](https://github.com/SamSaffron/memory_profiler): Memory profiling tool
+- [`notable`](https://github.com/ankane/notable): Automatic tracking for requests and background jobs
+- [`pghero`](https://github.com/ankane/pghero): PostgreSQL insights
+- [`rack-mini-profiler`](https://github.com/MiniProfiler/rack-mini-profiler): Profiler for Rack applications
+- [`rails_performance`](https://github.com/igorkasyanchuk/rails_performance): Self-hosted performance monitoring
+- [`stackprof`](https://github.com/tmm1/stackprof): Sampling call-stack profiler
+
+Additional production dependencies (not automatically required):
+
+- [`freezolite`](https://github.com/ruby-next/freezolite): Automatic string freezing
+- [`pg_query`](https://github.com/pganalyze/pg_query): PostgreSQL query parsing
+
+### Development Dependencies
+
+- [`annotaterb`](https://github.com/drwl/annotaterb): Annotate Rails models
+- [`better_errors`](https://github.com/BetterErrors/better_errors): Better error page for Rails
+- [`binding_of_caller`](https://github.com/banister/binding_of_caller): Retrieve the binding of a method's caller
+- [`brakeman`](https://github.com/presidentbeef/brakeman): Security vulnerability scanner
+- [`bullet`](https://github.com/flyerhzm/bullet): Help to kill N+1 queries (automatically required in development)
+- [`bundler-audit`](https://github.com/rubysec/bundler-audit): Patch-level verification for Bundler
+- [`dotenv`](https://github.com/bkeepers/dotenv): Load environment variables from `.env`
+- [`erb-formatter`](https://github.com/nebulab/erb-formatter): ERB formatter
+- [`erb_lint`](https://github.com/Shopify/erb-lint): ERB linter
+- [`i18n-tasks`](https://github.com/glebm/i18n-tasks): Manage translation and localization
+- [`rubocop`](https://github.com/rubocop/rubocop) and related gems: Ruby static code analyzer and formatter
+
+## Configuration
+
+### Rubocop
+
+To use the `rubocop` configuration provided by `permadeps`, add the following to your `.rubocop.yml`:
 
 ```yml
 inherit_gem:
@@ -60,22 +64,61 @@ inherit_gem:
     - rubocop.yml
 ```
 
-#### Formatters
+### Formatters
 
-`erb-formatter` and `erb_lint` requires the following VSCode extensions to work properly:
+For `erb-formatter` and `erb_lint` to work properly in VSCode, install these extensions:
 - [Ruby ERB::Formatter](https://marketplace.visualstudio.com/items?itemName=elia.erb-formatter)
 - [ERB Linter](https://marketplace.visualstudio.com/items?itemName=manuelpuyol.erb-linter)
 
-Make sure to setup the other gems properly in your Rails application.
-
-### Generator
+## Generator
 
-The gem also provides a generator to install the necessary files to the Rails application:
+The gem provides a generator to install necessary files and configurations:
 
 ```bash
 $ rails g permadeps:install
 ```
 
+This generator will perform the following actions:
+
+1. Copy configuration files:
+  - `.annotaterb.yml`: Configuration for AnnotateRb
+  - `.better-html.yml`: Configuration for Better HTML
+  - `.env.example`: Example environment variables file
+  - `.erb-lint.yml`: Configuration for ERB Lint
+  - `.rubocop.yml`: Configuration for RuboCop
+
+2. Copy initializers:
+  - `config/initializers/better_html.rb`: Sets up Better HTML
+  - `config/initializers/blazer.rb`: Configures Blazer
+  - `config/initializers/rack_mini_profiler.rb`: Sets up Rack Mini Profiler
+  - `config/initializers/rails_performance.rb`: Sets up Rails Performance
+
+3. Add background jobs for PgHero:
+  - `app/jobs/capture_query_stats_job.rb`: Captures query statistics
+  - `app/jobs/capture_space_stats_job.rb`: Captures space usage statistics
+  - `app/jobs/clean_query_stats_job.rb`: Cleans up old query statistics
+  - `app/jobs/clean_space_stats_job.rb`: Cleans up old space usage statistics
+
+4. Add a rake task:
+  - `lib/tasks/annotate_rb.rake`: Task for running Annotate
+
+5. Run generators for various gems:
+  - `ahoy:install`: Sets up Ahoy for analytics
+  - `blazer:install`: Installs Blazer for business intelligence
+  - `good_job:install`: Sets up GoodJob
+  - `notable:requests`: Sets up Notable for request tracking
+  - `notable:jobs`: Sets up Notable for job tracking
+  - `pghero:query_stats`: Installs PgHero query stats
+  - `pghero:space_stats`: Installs PgHero space stats
+
+6. Set up Freezolite:
+  - Adds `require 'freezolite/auto'` to `config/application.rb` for automatic string freezing
+
+7. Run database migrations:
+  - Executes `rails db:migrate` to apply all pending migrations
+
+After running the generator, your Rails application will be configured with all the necessary settings and files to use the gems provided by permadeps. Make sure to review the generated files and adjust them as needed for your specific project requirements.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/permadeps/install/install_generator.rb

@@ -15,6 +15,7 @@ module Permadeps
         copy_file 'initializers/better_html.rb', 'config/initializers/better_html.rb'
         copy_file 'initializers/blazer.rb', 'config/initializers/blazer.rb'
         copy_file 'initializers/rack_mini_profiler.rb', 'config/initializers/rack_mini_profiler.rb'
+        copy_file 'initializers/rails_performance.rb', 'config/initializers/rails_performance.rb'
       end
 
       def copy_jobs
@@ -31,14 +32,73 @@ module Permadeps
       def run_generators
         generate 'ahoy:install'
         generate 'blazer:install'
+        generate 'good_job:install'
         generate 'notable:requests'
         generate 'notable:jobs'
         generate 'pghero:query_stats'
         generate 'pghero:space_stats'
       end
 
+      def setup_good_job # rubocop:disable Metrics/MethodLength
+        append_to_file 'Procfile.dev', "worker: bundle exec good_job start\n"
+
+        gsub_file(
+          'config/environments/production.rb',
+          '# config.active_job.queue_adapter = :resque',
+          'config.active_job.queue_adapter = :good_job'
+        )
+
+        insert_into_file 'config/environments/production.rb', before: /^end/ do
+          <<-RUBY
+
+  config.good_job.enable_cron = true
+
+  config.good_job.cron = {
+    capture_space_stats: {
+      cron: '*/5 * * * *',
+      class: 'CaptureSpaceStatsJob',
+      description: 'Capture PgHero space statistics every 5 minutes'
+    },
+    clean_space_stats: {
+      cron: '0 0 * * 5',
+      class: 'CleanSpaceStatsJob',
+      description: 'Clean PgHero space statistics every Friday midnight'
+    },
+    capture_query_stats: {
+      cron: '*/5 * * * *',
+      class: 'CaptureQueryStatsJob',
+      description: 'Capture PgHero query statistics every 5 minutes'
+    },
+    clean_query_stats: {
+      cron: '0 0 * * 5',
+      class: 'CleanQueryStatsJob',
+      description: 'Clean PgHero query statistics every Friday midnight'
+    }
+  }
+          RUBY
+        end
+      end
+
       def setup_freezolite_gem
-        insert_into_file 'config/application.rb', "\n\nrequire 'freezolite/auto'", after: "Bundler.require(*Rails.groups)"
+        insert_into_file(
+          'config/application.rb',
+          "\n\nrequire 'freezolite/auto'",
+          after: 'Bundler.require(*Rails.groups)'
+        )
+      end
+
+      def insert_engines
+        insert_into_file 'config/routes.rb', before: /^end/ do
+          <<-RUBY
+
+  authenticate :user, ->(user) { user.admin? } do
+    mount Blazer::Engine, at: 'rails/blazer'
+    mount GoodJob::Engine, at: 'rails/good_job'
+    mount PgHero::Engine, at: 'rails/pghero'
+    mount RailsPerformance::Engine, at: 'rails/performance'
+  end
+          RUBY
+        end
       end
 
       def run_migrations

data/lib/generators/permadeps/install/templates/initializers/rails_performance.rb

@@ -0,0 +1,42 @@
+if defined?(RailsPerformance)
+  Rails.autoloaders.main.on_load('RailsPerformance::RailsPerformanceController') do
+    RailsPerformance::RailsPerformanceController.content_security_policy false
+  end
+
+  RailsPerformance.setup do |config|
+    config.redis = Redis::Namespace.new("#{Rails.env}-rails-performance",
+                                        redis: Redis.new(url: ENV.fetch('REDIS_URL', 'redis://redis:6379')))
+    config.duration = 24.hours
+
+    config.debug = false # currently not used>
+    config.enabled = true
+
+    # default path where to mount gem
+    config.mount_at = '/rails/performance'
+
+    # protect your Performance Dashboard with HTTP BASIC password
+    config.http_basic_authentication_enabled = false
+    config.http_basic_authentication_user_name = 'rails_performance'
+    config.http_basic_authentication_password = 'password12'
+
+    # if you need an additional rules to check user permissions
+    config.verify_access_proc = proc { |_controller| true }
+    # for example when you have `current_user`
+    # config.verify_access_proc = proc { |controller| controller.current_user && controller.current_user.admin? }
+
+    # You can ignore endpoints with Rails standard notation controller#action
+    # config.ignored_endpoints = ['HomeController#contact']
+
+    # store custom data for the request
+    # config.custom_data_proc = proc do |env|
+    #   request = Rack::Request.new(env)
+    #   {
+    #     email: request.env['warden'].user&.email, # if you are using Devise for example
+    #     user_agent: request.env['HTTP_USER_AGENT']
+    #   }
+    # end
+
+    # config home button link
+    config.home_link = '/'
+  end
+end

data/lib/permadeps/version.rb

@@ -1,3 +1,3 @@
 module Permadeps
-  VERSION = '1446.1.3'
+  VERSION = '1446.1.4'
 end

data/lib/permadeps.rb

@@ -3,10 +3,12 @@ require 'blazer'
 require 'better_html'
 require 'flamegraph'
 require 'geocoder'
+require 'good_job'
 require 'memory_profiler'
 require 'notable'
 require 'pghero'
 require 'rack-mini-profiler'
+require 'rails_performance'
 require 'stackprof'
 
 require 'bullet' if defined?(Rails) && Rails.env.development?

data/permadeps.gemspec

@@ -39,11 +39,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'flamegraph', '~> 0.9.5'
   spec.add_dependency 'freezolite', '~> 0.5.0'
   spec.add_dependency 'geocoder', '~> 1.8', '>= 1.8.3'
+  spec.add_dependency 'good_job', '~> 4.1'
   spec.add_dependency 'memory_profiler', '~> 1.0', '>= 1.0.2'
   spec.add_dependency 'notable', '~> 0.5.2'
   spec.add_dependency 'pghero', '~> 3.6'
   spec.add_dependency 'pg_query', '~> 5.1'
   spec.add_dependency 'rack-mini-profiler', '~> 3.3', '>= 3.3.1'
+  spec.add_dependency 'rails_performance', '~> 1.2', '>= 1.2.2'
   spec.add_dependency 'stackprof', '~> 0.2.26'
 
   # Development dependencies:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permadeps
 version: !ruby/object:Gem::Version
-  version: 1446.1.3
+  version: 1446.1.4
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-27 00:00:00.000000000 Z
+date: 2024-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ahoy_matey
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: good_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: memory_profiler
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +208,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: rails_performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: stackprof
   requirement: !ruby/object:Gem::Requirement
@@ -543,6 +577,7 @@ files:
 - lib/generators/permadeps/install/templates/initializers/better_html.rb
 - lib/generators/permadeps/install/templates/initializers/blazer.rb
 - lib/generators/permadeps/install/templates/initializers/rack_mini_profiler.rb
+- lib/generators/permadeps/install/templates/initializers/rails_performance.rb
 - lib/generators/permadeps/install/templates/jobs/capture_query_stats_job.rb
 - lib/generators/permadeps/install/templates/jobs/capture_space_stats_job.rb
 - lib/generators/permadeps/install/templates/jobs/clean_query_stats_job.rb