modulorails 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d5b2d34ebfb4cd32e9525345fcec0969a007e51c98ce9f867c705b356fd45f7
-  data.tar.gz: ded0d0e132eaa268cef79057736268f77a75445934438d8c5b0c27c9d79d34b4
+  metadata.gz: 760fd66e14c2550bed2b01153e1ffbf34feefd585c106f5efb908d1830bfdda9
+  data.tar.gz: 57eb6276ff9fd86b507f6821109787c9475a0590cc8d0a55d52f84d85f69c57e
 SHA512:
-  metadata.gz: 3eceac15edde2df29ceefd5cccefd6e972c2fd53ec596a8ff5381df85860fc4fd7eebfe1c5f5ec67af90388e7452bcb35afdd7412095813217f16d5bf914c7a4
-  data.tar.gz: b3fbd4eb9077045aaaff2e83a74ade467116b0d697f8b51fc033d490adb3d41258bb12e7480293b7333e31b3ba12a0c4fdf03daecc80abc928f15bca1f396128
+  metadata.gz: '06768653acec08475061e970b53c159a5aa46abba7d5ba7978329b8808239e692fc52795e99edc4ecee1ff3a23b56ebf742dfd3facc430ad0cdfb0a31a697b25'
+  data.tar.gz: f221ee806067c428292088a0a2fe65d8e241a63386abd2e30cece257fb294151911fc271bce731d60136ffb0dea96bd458dcf3a5b6c3563be1e518809b0f9407

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 This file is used to list changes made in each version of the gem.
 
+# Unreleased
+
+# 1.4.0
+
+- Remove custom from standard health_check checks.
+- Update Postgres version from 15 to 16 in templates.
+- Fix template of `Dockerfile.prod` to install valid version of `bundler`.
+- Check required Ruby version of next Modulorails version before auto-update.
+- Remove Modulorails::Validators::DatabaseConfiguration since, with Docker Compose, it is no more necessary.
+
 # 1.3.2
 
 - Fix missing symbol in docker and gitlabci generators.

data/lib/generators/modulorails/docker/templates/Dockerfile.prod.tt

@@ -52,6 +52,7 @@ RUN apk add --update --no-cache \
     postgresql-dev \
     <%- end -%>
     && rm -rf .git/
+RUN gem install bundler -v <%= @data.bundler_version %>
 
 COPY --from=builder /app .
 

data/lib/generators/modulorails/docker/templates/docker-compose.prod.yml.tt

@@ -30,7 +30,7 @@ services:
       MYSQL_ROOT_HOST: '%'
   <%- else -%>
   database:
-    image: postgres:15-alpine
+    image: postgres:16-alpine
     volumes:
       - db_data:/var/lib/postgresql/data
     environment:

data/lib/generators/modulorails/docker/templates/docker-compose.yml.tt

@@ -34,7 +34,7 @@ services:
       MYSQL_ROOT_HOST: '%'
   <%- else -%>
   database:
-    image: postgres:15-alpine
+    image: postgres:16-alpine
     volumes:
       - db_data:/var/lib/postgresql/data
     environment:

data/lib/generators/modulorails/gitlabci/templates/.gitlab-ci.yml.tt

@@ -32,7 +32,7 @@ test:
     <%- if @adapter =~ /mysql/ -%>
     - mysql:8-alpine
     <%- else -%>
-    - postgres:15-alpine
+    - postgres:16-alpine
     <%- end -%>
     - redis:7-alpine
   variables:

data/lib/generators/modulorails/healthcheck/templates/config/initializers/health_check.rb.tt

@@ -35,7 +35,7 @@ HealthCheck.setup do |config|
   # config.buckets = { 'bucket_name' => %i[R W D] }
 
   # You can customize which checks happen on a standard health check, eg to set an explicit list use:
-  config.standard_checks = %w[database migrations custom]
+  config.standard_checks = %w[database migrations]
 
   # Or to exclude one check:
   config.standard_checks -= %w[emailconf]

data/lib/generators/modulorails/self_update/self_update_generator.rb

@@ -9,22 +9,30 @@ class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
   source_root File.expand_path('templates', __dir__)
   desc 'This generator updates Modulorails if required'
 
-  LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails/latest.json'
+  LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails.json'
 
   def create_config_file
-    modulorails_version = Gem::Version.new(Modulorails::VERSION)
-
     # Get the last published version
-    last_published_version_s = HTTParty.get(LATEST_VERSION_URL).parsed_response['version']
-    last_published_version   = Gem::Version.new(last_published_version_s)
+    last_published_version = HTTParty.get(LATEST_VERSION_URL).parsed_response.first
 
     # Do nothing if we could not fetch the last published version (whatever the reason)
-    # Or if the current version is the same as the last published version
-    return if last_published_version <= modulorails_version
+    return if last_published_version.nil?
+
+    requirement = last_published_version['ruby_version']
+    unless ruby_version_supported_by_next_gem_version?(requirement)
+      warn("Next Modulorails version requires Ruby version #{requirement}. You should update.")
+      return
+    end
+
+    modulorails_version = Gem::Version.new(Modulorails::VERSION)
+
+    # Do nothing if the current version is the same as the last published version
+    version = Gem::Version.new(last_published_version['number'])
+    return if version <= modulorails_version
 
     # Add gem to Gemfile
     gsub_file 'Gemfile', /^\s*gem\s['"]modulorails['"].*$/,
-              "gem 'modulorails', '= #{last_published_version}'"
+              "gem 'modulorails', '= #{version}'"
 
     # Update the gem and the Gemfile.lock
     system('bundle install')
@@ -32,4 +40,16 @@ class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
     warn("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
   end
 
+  private
+
+  def ruby_version_supported_by_next_gem_version?(requirement_string)
+    requirement = Gem::Requirement.new(requirement_string).requirements.first
+    comparison_method, required_version = requirement
+
+    COMPARABLE_RUBY_VERSION.send(comparison_method, required_version)
+  rescue StandardError
+    # If we cannot be sure of Ruby compatibility, do nothing
+    false
+  end
+
 end

data/lib/modulorails/railtie.rb

@@ -8,10 +8,10 @@ module Modulorails
     # Update and add gems before we load the configuration
     config.before_configuration do
       # Currently, we limit everything to the development environment
-      if Rails.env.development?
-        # Check database configuration
-        Modulorails.generate_healthcheck_template
-      end
+      next unless Rails.env.development?
+
+      # Check database configuration
+      Modulorails.generate_healthcheck_template
     end
 
     # Require the gem before we read the health_check initializer
@@ -35,28 +35,25 @@ module Modulorails
     # all gems, constants and configurations we might need.
     config.after_initialize do
       # Currently, we limit everything to the development environment
-      if Rails.env.development?
-        # Load translations
-        I18n.load_path += [File.expand_path('../../config/locales/en.yml', __dir__)]
+      next unless Rails.env.development?
 
-        # Effectively send the data to the intranet
-        Modulorails.send_data
+      # Load translations
+      I18n.load_path += [File.expand_path('../../config/locales/en.yml', __dir__)]
 
-        # Generate a template for CI/CD
-        Modulorails.generate_ci_template
+      # Effectively send the data to the intranet
+      Modulorails.send_data
 
-        # Check database configuration
-        Modulorails.check_database_config
+      # Generate a template for CI/CD
+      Modulorails.generate_ci_template
 
-        # Add/update Rubocop config
-        Modulorails.generate_rubocop_template
+      # Add/update Rubocop config
+      Modulorails.generate_rubocop_template
 
-        # Add/update Bundler-audit config
-        Modulorails.generate_bundleraudit_template
+      # Add/update Bundler-audit config
+      Modulorails.generate_bundleraudit_template
 
-        # Gem's self-update if a new version was released
-        Modulorails.self_update
-      end
+      # Gem's self-update if a new version was released
+      Modulorails.self_update
     end
 
   end

data/lib/modulorails/version.rb

@@ -1,6 +1,6 @@
 module Modulorails
 
-  VERSION = '1.3.2'.freeze
+  VERSION = '1.4.0'.freeze
 
   # Useful to compare the current Ruby version
   COMPARABLE_RUBY_VERSION = Gem::Version.new(RUBY_VERSION)

data/lib/modulorails.rb

@@ -1,7 +1,6 @@
 require 'modulorails/version'
 require 'modulorails/configuration'
 require 'modulorails/data'
-require 'modulorails/validators/database_configuration'
 require 'modulorails/railtie' if defined?(Rails::Railtie)
 require 'generators/modulorails/gitlabci/gitlabci_generator'
 require 'generators/modulorails/healthcheck/health_check_generator'
@@ -120,31 +119,14 @@ module Modulorails
       Modulorails::GitlabciGenerator.new([], {}, {}).invoke_all
     end
 
-    # @author Matthieu 'ciappa_m' Ciappara
-    #
-    # Check the database configuration respects Modulotech's norms
-    def check_database_config
-      invalid_rules = Modulorails::Validators::DatabaseConfiguration.call
-      return true if invalid_rules.empty?
-
-      puts('[Modulorails] The database configuration (config/database.yml) has warnings:')
-      invalid_rules.each do |rule|
-        t_rule = I18n.t(rule, scope: :modulorails, locale: :en)
-        puts("[Modulorails]    Invalid database configuration: #{t_rule}")
-      end
-
-      false
-    end
-
     # @author Matthieu 'ciappa_m' Ciappara
     #
     # Check the last version of Modulorails available on rubygems and update if there was a
     # publication
     def self_update
-      unless configuration.no_auto_update
-        Modulorails::SelfUpdateGenerator.new([], {},
-                                             {}).invoke_all
-      end
+      return if configuration.no_auto_update
+
+      Modulorails::SelfUpdateGenerator.new([], {}, {}).invoke_all
     rescue StandardError => e
       puts("[Modulorails] An error occured: #{e.class} - #{e.message}")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -239,7 +239,6 @@ files:
 - lib/modulorails/services/logs_for_method_service.rb
 - lib/modulorails/services/services.rb
 - lib/modulorails/success_data.rb
-- lib/modulorails/validators/database_configuration.rb
 - lib/modulorails/version.rb
 - modulorails.gemspec
 homepage: https://github.com/moduloTech/modulorails

data/lib/modulorails/validators/database_configuration.rb

@@ -1,109 +0,0 @@
-module Modulorails
-
-  module Validators
-
-    # Author: Matthieu 'ciappa_m' Ciappara
-    # This holds the rules to configure the database by respecting Modulotech's norms.
-    class DatabaseConfiguration
-
-      def initialize
-        # All rules are invalid by default
-        @rules = {
-          standard_config_file_location:         false,
-          test_database_not_equals_dev_database: false,
-          development:                           {
-            configurable_username: false,
-            configurable_password: false,
-            configurable_database: false,
-            configurable_host:     false,
-            configurable_port:     false
-          },
-          test:                                  {
-            configurable_username: false,
-            configurable_password: false,
-            configurable_database: false,
-            configurable_host:     false,
-            configurable_port:     false
-          }
-        }
-      end
-
-      def self.call
-        new.call
-      end
-
-      def call
-        database_configuration = check_standard_config_file_location
-        return [:standard_config_file_location] unless database_configuration
-
-        check_test_database_not_equals_dev_database(database_configuration)
-        check_rules_for_environment(database_configuration, :development)
-        check_rules_for_environment(database_configuration, :test)
-
-        fetch_invalid_rules
-      end
-
-      private
-
-      def fetch_invalid_rules
-        dev     = select_invalid_keys(@rules[:development]).map { |k| "development.#{k}" }
-        test    = select_invalid_keys(@rules[:test]).map { |k| "test.#{k}" }
-        general = select_invalid_keys(@rules)
-
-        general + dev + test
-      end
-
-      def select_invalid_keys(hash)
-        hash.select { |_k, v| v == false }.keys
-      end
-
-      def check_standard_config_file_location
-        # Load the configuration
-        config = if Modulorails::COMPARABLE_RUBY_VERSION >= Gem::Version.new('3.1')
-                   # Ruby 3.1 uses Psych4 which changes the default way of handling aliases in
-                   # `load_file`.
-                   Psych.load_file(Rails.root.join('config/database.yml'), aliases: true)
-                 else
-                   Psych.load_file(Rails.root.join('config/database.yml'))
-                 end
-
-        # If no exception was raised, then the database configuration file is at standard location
-        @rules[:standard_config_file_location] = true
-
-        config
-      rescue StandardError
-        # An exception was raised, either the file is not a the standard location, either it just
-        # cannot be read. Either way, we consider the config as invalid
-        @rules[:standard_config_file_location] = false
-        nil
-      end
-
-      # The database for tests MUST NOT be the same as the development database since the test
-      # database is rewritten each time the tests are launched
-      def check_test_database_not_equals_dev_database(config)
-        @rules[:test_database_not_equals_dev_database] =
-          config['test']['database'] != config['development']['database']
-      end
-
-      # Check all rules for an environment
-      def check_rules_for_environment(config, env)
-        @rules[env].each_key do |rule|
-          key = rule.to_s.gsub(/configurable_/, '')
-          check_configurable_key_for_environment(config, env, key)
-        end
-      end
-
-      # Check if the given key is configurable for the given environment
-      def check_configurable_key_for_environment(config, env, key)
-        valid_rule = config[env.to_s][key] =~ /<%=\s*ENV\.fetch\(\S+,\s*\S+\)\s*%>/
-        valid_rule ||= config[env.to_s][key] =~ /<%=\s*ENV\.fetch\(.+\)\s*\{\s*\S+\s*\}\s*%>/
-
-        # Use of `!!` to convert `nil` to `false` and `0` to `true`
-        @rules[env][:"configurable_#{key}"] = !!valid_rule
-      end
-
-    end
-
-  end
-
-end