modulorails 1.0.2 → 1.1.0

data/lib/modulorails/data.rb

@@ -3,47 +3,90 @@ require 'active_record'
 require 'git'
 
 module Modulorails
+
   # Author: Matthieu 'ciappa_m' Ciappara
   # This holds the data gathered by the gem. Some come from the configuration by the gem's user.
   # Some are fetched dynamically.
   class Data
+
     # All the data handled by this class
     ATTRIBUTE_KEYS = %i[
       name main_developer project_manager repository type rails_name ruby_version rails_version
-      bundler_version modulorails_version adapter db_version adapter_version production_url
-      staging_url review_base_url
+      bundler_version modulorails_version adapter db_version adapter_version webpacker_version
+      importmap_version jsbundling_version
+      production_url staging_url review_base_url
     ].freeze
 
     # Useful if the gem's user need to read one of the data
-    attr_reader *ATTRIBUTE_KEYS
+    attr_reader(*ATTRIBUTE_KEYS)
 
     def initialize
+      initialize_from_constants
+      initialize_from_configuration
+      initialize_from_database
+      initialize_from_gem_specs
+      initialize_from_git
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    # @return [String] Text version of the data
+    def to_s
+      ATTRIBUTE_KEYS.map { |key| "#{key}: #{send(key)}" }.join(', ')
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    # @return [Hash] The payload for the request to the intranet
+    def to_params
+      {
+        'name'            => @name,
+        'main_developer'  => @main_developer,
+        'project_manager' => @project_manager,
+        'repository'      => @repository,
+        'app_type'        => @type,
+        'project_data'    => to_project_data_params
+      }
+    end
+
+    private
+
+    def initialize_from_constants
+      # The API can handle more project types but this gem is (obviously) intended for Rails
+      # projects only
+      @type = 'rails'
+
+      # The name defined for the Rails application; it can be completely different from the usual
+      # name or can be the same
+      @rails_name = ::Rails.application.class.name&.split('::')&.first
+
+      # The Ruby version used by the application
+      @ruby_version = RUBY_VERSION
+
+      # The version of the gem
+      @modulorails_version = Modulorails::VERSION
+    end
+
+    def initialize_from_configuration
       # Get the gem's configuration to get the application's usual name, main dev and PM
       configuration = Modulorails.configuration
-      # Get the database connection to identify the database used by the application
-      # or return nil if the database does not exist
-      db_connection = begin
-                        ActiveRecord::Base.connection
-                      rescue ActiveRecord::NoDatabaseError => e
-                        $stderr.puts("[Modulorails] Error: #{e.message}")
-                        nil
-                      end
-      # Get the gem's specifications to fetch the versions of critical gems
-      loaded_specs = Gem.loaded_specs
 
       # The data written by the user in the configuration
       # The name is the usual name of the project, the one used in conversations at Modulotech
       @name = configuration.name
+
       # The main developer, the lead developer, in short the developer to call when something's
       # wrong with the application ;)
       @main_developer = configuration.main_developer
+
       # The project manager of the application; the other person to call when something's wrong with
       # the application ;)
       @project_manager = configuration.project_manager
+
       # The URL of the production environment for the application
       @production_url = configuration.production_url
+
       # The URL of the staging environment for the application
       @staging_url = configuration.staging_url
+
       # The base URL of the review environment for the application.
       # A real review URL is built like this at Modulotech:
       # https://review-#{shortened_branch_name}-#{ci_slug}.#{review_base_url}
@@ -53,21 +96,29 @@ module Modulorails
       # ci_slug: jzzham
       # |-> https://review-786-a_sup-jzzham.dev.app.com/
       @review_base_url = configuration.review_base_url
+    end
 
-      # Theorically, origin is the main repository of the project and git is the sole VCS we use
-      # at Modulotech
-      @repository = Git.open(::Rails.root).config('remote.origin.url')
+    def initialize_from_database
+      # Get the database connection to identify the database used by the application
+      # or return nil if the database does not exist
+      db_connection = begin
+        ActiveRecord::Base.connection
+      rescue ActiveRecord::NoDatabaseError, ActiveRecord::ConnectionNotEstablished => e
+        warn("[Modulorails] Error: #{e.message}")
+        nil
+      end
 
-      # The API can handle more project types but this gem is (obviously) intended for Rails
-      # projects only
-      @type = 'rails'
+      # The name of the ActiveRecord adapter; it gives the name of the database system too
+      @adapter = db_connection&.adapter_name&.downcase
 
-      # The name defined for the Rails application; it can be completely different from the usual
-      # name or can be the same
-      @rails_name = ::Rails.application.class.name.split('::').first
+      # The version of the database engine; this request works only on MySQL and PostgreSQL
+      # It should not be a problem since those are the sole database engines used at Modulotech
+      @db_version = db_connection&.select_value('SELECT version()')
+    end
 
-      # The Ruby version used by the application
-      @ruby_version = RUBY_VERSION
+    def initialize_from_gem_specs
+      # Get the gem's specifications to fetch the versions of critical gems
+      loaded_specs = Gem.loaded_specs
 
       # The Rails version used by the application
       @rails_version = loaded_specs['rails'].version.version
@@ -76,53 +127,53 @@ module Modulorails
       # Bundler 1 are not compatible)
       @bundler_version = loaded_specs['bundler'].version.version
 
-      # The version of the gem
-      @modulorails_version = Modulorails::VERSION
+      # The version of the ActiveRecord adapter
+      @adapter_version = loaded_specs[@adapter]&.version&.version
 
-      # The name of the ActiveRecord adapter; it gives the name of the database system too
-      @adapter = db_connection&.adapter_name&.downcase
+      # The version of the webpacker gem - might be nil
+      @webpacker_version = loaded_specs['webpacker']&.version&.version
 
-      # The version of the database engine; this request works only on MySQL and PostgreSQL
-      # It should not be a problem since those are the sole database engines used at Modulotech
-      @db_version = db_connection&.select_value('SELECT version()')
+      # The version of the importmap-rails gem - might be nil
+      @importmap_version = loaded_specs['importmap-rails']&.version&.version
 
-      # The version of the ActiveRecord adapter
-      @adapter_version = loaded_specs[@adapter]&.version&.version
+      # The version of the jsbundling-rails gem - might be nil
+      @jsbundling_version = loaded_specs['jsbundling-rails']&.version&.version
     end
 
-    # @author Matthieu 'ciappa_m' Ciappara
-    # @return [String] Text version of the data
-    def to_s
-      ATTRIBUTE_KEYS.map { |key| "#{key}: #{send(key)}" }.join(', ')
+    def initialize_from_git
+      # Theorically, origin is the main repository of the project and git is the sole VCS we use
+      # at Modulotech
+      @repository = Git.open(::Rails.root).config('remote.origin.url')
     end
 
-    # @author Matthieu 'ciappa_m' Ciappara
-    # @return [Hash] The payload for the request to the intranet
-    def to_params
+    def to_project_data_params
       {
-        'name'            => @name,
-        'main_developer'  => @main_developer,
-        'project_manager' => @project_manager,
-        'repository'      => @repository,
-        'app_type'        => @type,
-        'project_data'    => {
-          'name'                => @rails_name,
-          'ruby_version'        => @ruby_version,
-          'rails_version'       => @rails_version,
-          'bundler_version'     => @bundler_version,
-          'modulorails_version' => @modulorails_version,
-          'database'            => {
-            'adapter'     => @adapter,
-            'db_version'  => @db_version,
-            'gem_version' => @adapter_version
-          },
-          'urls'                => {
-            'production'  => @production_url,
-            'staging'     => @staging_url,
-            'review_base' => @review_base_url
-          }
-        }
+        'name'                => @rails_name,
+        'ruby_version'        => @ruby_version,
+        'rails_version'       => @rails_version,
+        'bundler_version'     => @bundler_version,
+        'modulorails_version' => @modulorails_version,
+        'database'            => to_database_params,
+        'urls'                => to_urls_params
+      }
+    end
+
+    def to_database_params
+      {
+        'adapter'     => @adapter,
+        'db_version'  => @db_version,
+        'gem_version' => @adapter_version
       }
     end
+
+    def to_urls_params
+      {
+        'production'  => @production_url,
+        'staging'     => @staging_url,
+        'review_base' => @review_base_url
+      }
+    end
+
   end
+
 end

data/lib/modulorails/error_data.rb

@@ -1,6 +1,7 @@
 # @author Matthieu Ciappara <ciappa_m@modulotech>
 # An error encountered during an operation with additional data.
 class Modulorails::ErrorData
+
   # @!attribute r errors
   #   An error message or an array of error messages (those will be joined by a coma and a space).
   # @!attribute r exception
@@ -18,4 +19,5 @@ class Modulorails::ErrorData
   def success?
     false
   end
+
 end

data/lib/modulorails/errors/invalid_format_error.rb

@@ -1,6 +1,7 @@
 # @author Matthieu CIAPPARA <ciappa_m@modulotech.fr>
 # An exception representing an invalid format for a given field.
 class Modulorails::InvalidFormatError < Modulorails::BaseError
+
   # @!attribute r field
   #   The name of the field that had a wrong format.
   attr_reader :field
@@ -11,4 +12,5 @@ class Modulorails::InvalidFormatError < Modulorails::BaseError
 
     @field = field
   end
+
 end

data/lib/modulorails/errors/invalid_value_error.rb

@@ -1,6 +1,7 @@
 # @author Matthieu CIAPPARA <ciappa_m@modulotech.fr>
 # An exception representing an invalid value for a given field.
 class Modulorails::InvalidValueError < Modulorails::BaseError
+
   # @!attribute r field
   #   The name of the field that had a wrong value.
   attr_reader :field
@@ -11,4 +12,5 @@ class Modulorails::InvalidValueError < Modulorails::BaseError
 
     @field = field
   end
+
 end

data/lib/modulorails/railtie.rb

@@ -1,8 +1,10 @@
 require_relative '../../app/helpers/modulorails/application_helper'
 
 module Modulorails
+
   # Bind in the Rails lifecycle
   class Railtie < ::Rails::Railtie
+
     # Update and add gems before we load the configuration
     config.before_configuration do
       # Currently, we limit everything to the development environment
@@ -35,7 +37,7 @@ module Modulorails
       # Currently, we limit everything to the development environment
       if Rails.env.development?
         # Load translations
-        I18n.load_path += [File.expand_path('../../../config/locales/en.yml', __FILE__)]
+        I18n.load_path += [File.expand_path('../../config/locales/en.yml', __dir__)]
 
         # Effectively send the data to the intranet
         Modulorails.send_data
@@ -53,5 +55,7 @@ module Modulorails
         Modulorails.self_update
       end
     end
+
   end
+
 end

data/lib/modulorails/services/base_service.rb

@@ -2,6 +2,7 @@
 # The base class for services. Should be implemented by ApplicationService following the model of
 # ActiveRecord::Base and ApplicationRecord.
 class Modulorails::BaseService
+
   # Allow to instantiate the service and call the service in one go.
   if Modulorails::COMPARABLE_RUBY_VERSION < Gem::Version.new('3.0')
     def self.call(*args, &block)
@@ -28,7 +29,7 @@ class Modulorails::BaseService
   end
 
   # Shamelessly copied from text_helper
-  def self.pluralize(count, singular, plural_arg = nil, plural: plural_arg, locale: I18n.locale)
+  def self.pluralize(count, singular, plural_arg=nil, plural: plural_arg, locale: I18n.locale)
     word = if count == 1 || count =~ /^1(\.0+)?$/
              singular
            else
@@ -65,7 +66,9 @@ class Modulorails::BaseService
   rescue StandardError => e
     # Unknown error, log the error
     Rails.logger.error("#{self}: #{e.message}")
-    Rails.logger.error("Local variables: #{local_variables.map! { |v| { v => eval(v.to_s, binding) } }}")
+    Rails.logger.error("Local variables: #{local_variables.map! { |v|
+      { v => binding.local_variable_get(v) }
+    } }")
     Rails.logger.error(e.backtrace&.join("\n"))
 
     # Return the error
@@ -76,7 +79,7 @@ class Modulorails::BaseService
   # @param from [String,ActiveSupport::TimeWithZone] the minimum date
   # @param to [String,ActiveSupport::TimeWithZone] the maximum date
   # @return [[ActiveSupport::TimeWithZone, ActiveSupport::TimeWithZone]] The given dates casted.
-  def params_to_time(from, to = nil)
+  def params_to_time(from, to=nil)
     from = from.is_a?(String) && from.present? ? from.to_time_with_zone : from
     to   = if to.is_a?(String) && to.present?
              to = to.to_time_with_zone
@@ -92,7 +95,7 @@ class Modulorails::BaseService
   end
 
   # Shamelessly copied from text_helper
-  def pluralize(count, singular, plural_arg = nil, plural: plural_arg, locale: I18n.locale)
+  def pluralize(count, singular, plural_arg=nil, plural: plural_arg, locale: I18n.locale)
     self.class.pluralize(count, singular, plural_arg, plural: plural, locale: locale)
   end
 
@@ -141,7 +144,9 @@ class Modulorails::BaseService
     value = params.dig(*keys)
 
     if value.respond_to?(:each)
-      raise InvalidValueError.new(keys.join('/')) unless value.all? { |v| allowed_values.include?(v) }
+      raise InvalidValueError.new(keys.join('/')) unless value.all? { |v|
+        allowed_values.include?(v)
+      }
     else
       return nil if !value && allow_nil
 
@@ -162,11 +167,9 @@ class Modulorails::BaseService
     value = params.dig(*keys)
 
     unless value
-      if allow_nil
-        return nil
-      else
-        raise InvalidValueError.new(keys.join('/'))
-      end
+      return nil if allow_nil
+
+      raise InvalidValueError.new(keys.join('/'))
     end
 
     result = model.find_by(field => value)
@@ -187,11 +190,9 @@ class Modulorails::BaseService
     values = params.dig(*keys)
 
     if values.blank?
-      if allow_nil
-        return nil
-      else
-        raise InvalidValueError.new(keys.join('/'))
-      end
+      return nil if allow_nil
+
+      raise InvalidValueError.new(keys.join('/'))
     end
 
     results = model.where(field => values)
@@ -200,4 +201,5 @@ class Modulorails::BaseService
 
     results
   end
+
 end

data/lib/modulorails/services/logs_for_method_service.rb

@@ -39,4 +39,5 @@ class Modulorails::LogsForMethodService < Modulorails::BaseService
   def jsonify
     @message.to_json
   end
+
 end

data/lib/modulorails/success_data.rb

@@ -1,6 +1,7 @@
 # @author Matthieu Ciappara <ciappa_m@modulotech>
 # A success resulting from an operation with optional additional data.
 class Modulorails::SuccessData
+
   # @!attribute r data
   #   An object to transport some data (for instance the result of the operation). Defaults to nil.
   attr_reader :data
@@ -14,4 +15,5 @@ class Modulorails::SuccessData
   def success?
     true
   end
+
 end

data/lib/modulorails/validators/database_configuration.rb

@@ -1,8 +1,11 @@
 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 = {
@@ -37,19 +40,23 @@ module Modulorails
         check_rules_for_environment(database_configuration, :development)
         check_rules_for_environment(database_configuration, :test)
 
-        get_invalid_rules
+        fetch_invalid_rules
       end
 
       private
 
-      def get_invalid_rules
-        dev     = @rules[:development].select { |_k, v| v == false }.keys.map { |k| "development.#{k}" }
-        test    = @rules[:test].select { |_k, v| v == false }.keys.map { |k| "test.#{k}" }
-        general = @rules.select { |_k, v| v == false }.keys
+      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')
@@ -64,7 +71,7 @@ module Modulorails
         @rules[:standard_config_file_location] = true
 
         config
-      rescue StandardError => e
+      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
@@ -74,13 +81,13 @@ module Modulorails
       # 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)
-        test_eq_database                               = config['test']['database'] != config['development']['database']
-        @rules[:test_database_not_equals_dev_database] = test_eq_database
+        @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].keys.each do |rule|
+        @rules[env].each_key do |rule|
           key = rule.to_s.gsub(/configurable_/, '')
           check_configurable_key_for_environment(config, env, key)
         end
@@ -94,6 +101,9 @@ module Modulorails
         # Use of `!!` to convert `nil` to `false` and `0` to `true`
         @rules[env][:"configurable_#{key}"] = !!valid_rule
       end
+
     end
+
   end
+
 end

data/lib/modulorails/version.rb

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

data/lib/modulorails.rb

@@ -17,11 +17,13 @@ require 'modulorails/services/services'
 # The entry point of the gem. It exposes the configurator, the gathered data and the method to
 # send those data to the intranet.
 module Modulorails
+
   # Author: Matthieu 'ciappa_m' Ciappara
   # The error class of the gem. Allow to identify all functional errors raised by the gem.
   class Error < StandardError; end
 
   class << self
+
     # Useful to update the configuration
     attr_writer :configuration
 
@@ -73,38 +75,38 @@ module Modulorails
       # If no endpoint and/or no API key is configured, it is impossible to send the data to the
       # intranet and thus we raise an error: it is the only error we want to raise since it goes
       # against one of the main goals of the gem and the gem's user is responsible.
-      if configuration.endpoint && configuration.api_key
-        # Define the headers of the request ; sending JSON and API key to authenticate the gem on
-        # the intranet
-        headers = {
-          'Content-Type' => 'application/json', 'X-MODULORAILS-TOKEN' => configuration.api_key
-        }
-
-        # Define the JSON body of the request
-        body = data.to_params.to_json
-
-        # Prevent HTTParty to raise error and crash the server in dev
-        begin
-          # Post to the configured endpoint on the Intranet
-          response = HTTParty.post(configuration.endpoint, headers: headers, body: body)
-
-          # According to the API specification, on a "Bad request" response, the server explicits what
-          # went wrong with an `errors` field. We do not want to raise since the gem's user is not
-          # (necessarily) responsible for the error but we still need to display it somewhere to warn
-          # the user something went wrong.
-          puts("[Modulorails] Error: #{response['errors'].join(', ')}") if response.code == 400
-
-          # Return the response to allow users to do some more
-          response
-        rescue StandardError => e
-          # Still need to notify the user
-          puts("[Modulorails] Error: Could not post to #{configuration.endpoint}")
-          puts e.message
-          nil
-        end
-      else
+      unless configuration.endpoint && configuration.api_key
         raise Error.new('No endpoint or api key')
       end
+
+      # Define the headers of the request ; sending JSON and API key to authenticate the gem on
+      # the intranet
+      headers = {
+        'Content-Type' => 'application/json', 'X-MODULORAILS-TOKEN' => configuration.api_key
+      }
+
+      # Define the JSON body of the request
+      body = data.to_params.to_json
+
+      # Prevent HTTParty to raise error and crash the server in dev
+      begin
+        # Post to the configured endpoint on the Intranet
+        response = HTTParty.post(configuration.endpoint, headers: headers, body: body)
+
+        # According to the API specification, on a "Bad request" response, the server explicits what
+        # went wrong with an `errors` field. We do not want to raise since the gem's user is not
+        # (necessarily) responsible for the error but we still need to display it somewhere to warn
+        # the user something went wrong.
+        puts("[Modulorails] Error: #{response['errors'].join(', ')}") if response.code == 400
+
+        # Return the response to allow users to do some more
+        response
+      rescue StandardError => e
+        # Still need to notify the user
+        puts("[Modulorails] Error: Could not post to #{configuration.endpoint}")
+        puts e.message
+        nil
+      end
     end
 
     # @author Matthieu 'ciappa_m' Ciappara
@@ -112,7 +114,7 @@ module Modulorails
     # Generate a CI/CD template unless it was already done.
     # The check is done using a 'keepfile'.
     def generate_ci_template
-      return if File.exists?(Rails.root.join('.modulorails-gitlab-ci'))
+      return if File.exist?(Rails.root.join('.modulorails-gitlab-ci'))
 
       Modulorails::GitlabciGenerator.new([], {}, {}).invoke_all
     end
@@ -138,7 +140,10 @@ module Modulorails
     # Check the last version of Modulorails available on rubygems and update if there was a
     # publication
     def self_update
-      Modulorails::SelfUpdateGenerator.new([], {}, {}).invoke_all unless configuration.no_auto_update
+      unless configuration.no_auto_update
+        Modulorails::SelfUpdateGenerator.new([], {},
+                                             {}).invoke_all
+      end
     rescue StandardError => e
       puts("[Modulorails] An error occured: #{e.class} - #{e.message}")
     end
@@ -148,7 +153,7 @@ module Modulorails
     # Generate a health_check configuration unless it was already done.
     # The check is done using a 'keepfile'.
     def generate_healthcheck_template
-      return if File.exists?(Rails.root.join('.modulorails-health_check'))
+      return if File.exist?(Rails.root.join('.modulorails-health_check'))
 
       Modulorails::HealthCheckGenerator.new([], {}, {}).invoke_all
     end
@@ -159,5 +164,7 @@ module Modulorails
     def generate_rubocop_template
       Modulorails::RubocopGenerator.new([], {}, {}).invoke_all
     end
+
   end
+
 end

data/modulorails.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['ciappa_m@modulotech.fr']
 
   spec.summary       = 'Common base for Ruby on Rails projects at Modulotech'
-  spec.description   =<<~END_OF_TEXT
+  spec.description = <<~END_OF_TEXT
     Modulorails is the common base for the Ruby on Rails project at Modulotech
     (https://www.modulotech.fr/).
 
@@ -24,19 +24,20 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'railties', '>= 4.2.0'
   spec.add_runtime_dependency 'git', '~> 1.7', '>= 1.7.0'
-  spec.add_runtime_dependency 'httparty'
-  spec.add_runtime_dependency 'i18n'
   spec.add_runtime_dependency 'health_check', '~> 3.1'
-  spec.add_runtime_dependency 'rubocop', '= 1.25.1'
-  spec.add_runtime_dependency 'rubocop-rails', '= 2.13.2'
+  spec.add_runtime_dependency 'httparty', '>= 0.13.3'
+  spec.add_runtime_dependency 'i18n', '>= 0.9.5'
+  spec.add_runtime_dependency 'railties', '>= 4.2.0'
+  spec.add_runtime_dependency 'rubocop', '>= 1.28.2'
+  spec.add_runtime_dependency 'rubocop-rails', '>= 2.14.2'
 
   spec.add_development_dependency 'activerecord', '>= 4.2.0'
   spec.add_development_dependency 'appraisal'
+  # spec.metadata['rubygems_mfa_required'] = 'true'
 end