modulorails 1.0.2 → 1.2.0

data/lib/generators/modulorails/rubocop/templates/rubocop.yml.tt

@@ -9,10 +9,259 @@
 #
 # See https://docs.rubocop.org/rubocop/configuration
 
-inherit_gem:
-  modulorails: .rubocop.yml
+# Enabling Rails-specific cops.
+require: rubocop-rails
 
-# Take into account the exclude list from the gem
 inherit_mode:
   merge:
     - Exclude
+    - Include
+
+AllCops:
+  # No suggestions since the gem is the sole truth for rubocop configuration.
+  SuggestExtensions: false
+
+  # Enable new cops by default
+  NewCops: enable
+
+  # Excluding most directories with generated files and directories with configuration files.
+  Exclude:
+    - 'vendor/**/*'
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'bin'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Capfile'
+    - '**/Rakefile'
+    - 'config/**/*'
+    - 'test/**/*'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+
+# Instructing rubocop about all standard Modulotech environments.
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - development
+    - test
+    - staging
+    - preprod
+
+# Checks if String literals are using single quotes when no interpolation is required
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: false
+
+# Checks if the quotes used for quoted symbols are single quotes when no interpolation is required
+Style/QuotedSymbols:
+  Enabled: true
+  EnforcedStyle: same_as_string_literals
+
+# This cop checks for uses of literal strings converted to a symbol where a literal symbol could be used instead.
+Lint/SymbolConversion:
+  Enabled: true
+  EnforcedStyle: strict
+
+# Useless cop. It checks for unnecessary safe navigations.
+# Example:
+# obj&.a && obj.b
+# Triggers rubocop error: it requires to add safe navigation for "obj.b" call => "obj&.b".
+# but it is not necessary. obj&.a will return nil if obj is nil, and it will stop
+# execution of the operation because `&&` right part executes only when left part is truthy.
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# Disabled because moving from default arguments to keywords is not that easy.
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Checks for use of the lambda.(args) syntax.
+# Disabled while the Ruby team has not voted on this.
+Style/LambdaCall:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# Disabled because it would break a lot of permitted_params definitions
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Checks for grouping of accessors in class and module bodies.
+# Useless.
+Style/AccessorGrouping:
+  Enabled: false
+
+# Makes our lives happier: we don't need to disable it in each case/when method
+# with more than 5 "when"s.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 100
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Annotated or template are too verbose and rarely needed.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# Disable frozen string
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable No ASCII char in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Disable ordered Gems By ascii
+Bundler/OrderedGems:
+  Enabled: false
+
+# Change ABC max value
+Metrics/AbcSize:
+  Max: 35
+
+# Disable empty method in one line
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disable max height block
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'app/admin/**/*'
+    - 'lib/tasks/**/*'
+
+# Checks if empty lines around the bodies of classes match the configuration.
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+# Checks if empty lines around the bodies of modules match the configuration.
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+# Enforces the consistent usage of %-literal delimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+# Unnecessary cop. In what universe "A || B && C" or "A && B || C && D" is ambiguous? looks
+# like a cop for those who can't in boolean.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Checks for simple usages of parallel assignment.
+Style/ParallelAssignment:
+  Enabled: false
+
+# Checks the style of children definitions at classes and modules.
+Style/ClassAndModuleChildren:
+  Enabled: false

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

@@ -5,10 +5,11 @@ require 'rails/generators'
 # Author: Matthieu 'ciappa_m' Ciappara
 # This updates modulorails by editing the gemfile and running a bundle update
 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'.freeze
+  LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails/latest.json'
 
   def create_config_file
     modulorails_version = Gem::Version.new(Modulorails::VERSION)
@@ -22,11 +23,13 @@ class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
     return if last_published_version <= modulorails_version
 
     # Add gem to Gemfile
-    gsub_file 'Gemfile', /^\s*gem\s['"]modulorails['"].*$/, "gem 'modulorails', '= #{last_published_version}'"
+    gsub_file 'Gemfile', /^\s*gem\s['"]modulorails['"].*$/,
+              "gem 'modulorails', '= #{last_published_version}'"
 
     # Update the gem and the Gemfile.lock
     system('bundle install')
   rescue StandardError => e
-    $stderr.puts("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
+    warn("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
   end
+
 end

data/lib/generators/modulorails/service/service_generator.rb

@@ -3,11 +3,13 @@
 require 'rails/generators'
 
 class Modulorails::ServiceGenerator < Rails::Generators::NamedBase
+
   source_root File.expand_path('templates', __dir__)
   desc 'This generator creates a service inheriting Modulorails::BaseService'
   argument :arguments, type: :array, default: [], banner: 'argument argument'
 
   def create_service_files
-    template "service.rb", File.join("app/services", class_path, "#{file_name}_service.rb")
+    template 'service.rb', File.join('app/services', class_path, "#{file_name}_service.rb")
   end
+
 end

data/lib/modulorails/configuration.rb

@@ -1,7 +1,9 @@
 module Modulorails
+
   # Author: Matthieu 'ciappa_m' Ciappara
   # The configuration of the gem
   class Configuration
+
     # All the keys to configure the gem
     attr_accessor :_name, :_main_developer, :_project_manager, :_endpoint, :_api_key,
                   :_no_auto_update, :_production_url, :_staging_url, :_review_base_url
@@ -30,5 +32,7 @@ module Modulorails
         send("_#{field}=", value)
       end
     end
+
   end
+
 end

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
@@ -49,9 +51,14 @@ module Modulorails
         # Add/update Rubocop config
         Modulorails.generate_rubocop_template
 
+        # Add/update Bundler-audit config
+        Modulorails.generate_bundleraudit_template
+
         # Gem's self-update if a new version was released
         Modulorails.self_update
       end
     end
+
   end
+
 end