modulorails 1.0.2 → 1.2.0

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.2.0'.freeze
 
   # Useful to compare the current Ruby version
   COMPARABLE_RUBY_VERSION = Gem::Version.new(RUBY_VERSION)
+
 end

data/lib/modulorails.rb

@@ -7,6 +7,7 @@ require 'generators/modulorails/gitlabci/gitlabci_generator'
 require 'generators/modulorails/healthcheck/health_check_generator'
 require 'generators/modulorails/self_update/self_update_generator'
 require 'generators/modulorails/rubocop/rubocop_generator'
+require 'generators/modulorails/bundleraudit/bundleraudit_generator'
 require 'httparty'
 require 'modulorails/error_data'
 require 'modulorails/success_data'
@@ -17,11 +18,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 +76,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 +115,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 +141,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 +154,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 +165,14 @@ module Modulorails
     def generate_rubocop_template
       Modulorails::RubocopGenerator.new([], {}, {}).invoke_all
     end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # Generate a bundler-audit configuration.
+    def generate_bundleraudit_template
+      Modulorails::BundlerauditGenerator.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,21 @@ 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_runtime_dependency 'bundler-audit', '~> 0.9.1'
 
   spec.add_development_dependency 'activerecord', '>= 4.2.0'
   spec.add_development_dependency 'appraisal'
+  # spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,119 +1,133 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: health_check
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
-  name: health_check
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.28.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.28.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 2.14.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,7 @@ files:
 - gemfiles/rails_60.gemfile
 - gemfiles/rails_61.gemfile
 - gemfiles/rails_70.gemfile
+- lib/generators/modulorails/bundleraudit/bundleraudit_generator.rb
 - lib/generators/modulorails/docker/docker_generator.rb
 - lib/generators/modulorails/docker/templates/Dockerfile.prod.tt
 - lib/generators/modulorails/docker/templates/Dockerfile.tt
@@ -195,7 +210,6 @@ files:
 - lib/generators/modulorails/gitlabci/gitlabci_generator.rb
 - lib/generators/modulorails/gitlabci/templates/.gitlab-ci.yml.tt
 - lib/generators/modulorails/gitlabci/templates/.modulorails-gitlab-ci
-- lib/generators/modulorails/gitlabci/templates/config/database-ci.yml.tt
 - lib/generators/modulorails/healthcheck/health_check_generator.rb
 - lib/generators/modulorails/healthcheck/templates/.modulorails-health_check
 - lib/generators/modulorails/healthcheck/templates/config/initializers/health_check.rb.tt

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

@@ -1,8 +0,0 @@
-<%- adapter = Modulorails.data.adapter -%>
-test:
-  host: <%= adapter =~ /mysql/ ? 'mysql' : 'postgres' %>
-  adapter: <%= adapter %>
-  database: test
-  username: root
-  password: password
-  encoding: utf8