modulorails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7a96938b07505567d256c051a9de1c495e145d2a3b5e8e0e90fbbb5e0eb0376
+  data.tar.gz: 3f11b735571b42d431ee155a3fd7169d6bf2b8eb40b88042ab7d98d5f9636119
+SHA512:
+  metadata.gz: 26076299430329d25d6137e293e4c7ba5d3577269358f59070b9f32dec7b8ea033be1c5c9f2d0016227d26c12d685124060f3188afb77318b7320e3acdcb0a36
+  data.tar.gz: 13d8bef4d1847342bdbf286546252bb570b96d3120f0d492170a19eff0d8aea25318e73583b69f695e3e8fa221ddce831399a5b70dad634254b5d47c302e35cc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+before_install:
+  - gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1 @@
+#  CHANGELOG

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rails@modulotech.fr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in modulorails.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: .
+  specs:
+    modulorails (0.1.0)
+      git (~> 1.7, >= 1.7.0)
+      httparty
+      railties (>= 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.7.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    rchardet (1.8.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 4.2.0)
+  modulorails!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Modulotech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# Modulorails [![Build Status](https://travis-ci.com/Ezveus/modulorails.svg?branch=master)](https://travis-ci.com/Ezveus/modulorails)
+
+**Modulorails** is the common base for the Ruby on Rails project at [Modulotech](https://www.modulotech.fr/).
+
+It registers each application using it on the company's intranet,
+provides templates for the common configurations and defines common dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'modulorails', git: 'git://github.com/moduloTech/modulorails.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+To work the gem needs to be configured. Add an initializer `config/modulorails.rb`:
+
+```ruby
+Modulorails.configure do |config|
+  config.name 'The usual name of the application'
+  config.main_developer 'The email of the main developer/maintainer of the application'
+  config.project_manager 'The email of the project manager of the application'
+  config.endpoint 'The url to the intranet'
+  config.api_key 'The API key'
+end
+``` 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/moduloTech/modulorails](https://github.com/moduloTech/modulorails). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/moduloTech/modulorails/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Modulorails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/moduloTech/modulorails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "modulorails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/gitlabci_generator.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class GitlabciGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  class_option(:app,
+               required: true, type: :string,
+               desc:     'Specify the application name.')
+  class_option(:database,
+               required: true, type: :string,
+               desc:     'Specify the database to use (either mysql or postgres).')
+  class_option(:bundler,
+               required: true, type: :string,
+               desc:     'Specify the Bundler version.')
+  class_option(:ruby_version,
+               required: true, type: :string,
+               desc:     'Specify the Ruby version.')
+  desc 'This generator creates a template for a .gitlab-ci.yml file at root'
+
+  # Configurations for MySQL/Postgres dockers
+  MYSQL_DOCKER_DB = <<~EOS
+    # Install a MySQL 5.7 database and configure mandatory environment variables
+    # (https://hub.docker.com/_/mysql/)
+    services:
+      - mysql:5.7
+    variables:
+      MYSQL_DATABASE: test
+      MYSQL_ROOT_PASSWORD: password
+  EOS
+  POSTGRES_DOCKER_DB = <<~EOS
+    # Install a Postgres 11 database and configure mandatory environment variables
+    # (https://hub.docker.com/_/postgres/)
+    services:
+      - postgresql:11
+    variables:
+      POSTGRES_DB: test
+      POSTGRES_PASSWORD: password
+  EOS
+
+  def create_config_file
+    # Get the configuration for the database engine
+    db_conf = database_config(options[:database])
+
+    # Update the gitlab-ci template
+    update_gitlab_ci(options, db_conf)
+
+    # Update the database-ci template
+    update_database_ci(db_conf)
+
+    # Create file to avoid this generator on next modulorails launch
+    create_keep_file
+  end
+
+  private
+
+  def update_gitlab_ci(options, db_conf)
+    file   = '.gitlab-ci.yml'
+    exists = File.exists?(file)
+
+    # Remove original file if there is one
+    remove_file file if exists
+
+    # Copy file
+    copy_file file, file
+
+    # Add the correct database docker
+    prepend_file file, db_conf[:header]
+
+    # Replace key for CI/CD cache
+    gsub_file file, 'CI_CD_CACHE_KEY', "#{options[:app]}-ci_cd"
+
+    # Replace key for bundler version
+    gsub_file file, 'BUNDLER_VERSION', options[:bundler]
+
+    # Replace ruby version
+    gsub_file file, 'RUBY_VERSION', '2.5.0'
+
+    # Warn the user about file overwrite/creation
+    warn_file_update(file, exists)
+  end
+
+  def update_database_ci(db_conf)
+    file = 'config/database-ci.yml'
+    exists = File.exists?(file)
+
+    # Remove original file if there is one
+    remove_file file if exists
+
+    # Copy file
+    copy_file file, file
+
+    # Replace configuration
+    gsub_file file, 'HOST', db_conf[:host]
+    gsub_file file, 'ADAPTER', db_conf[:adapter]
+    gsub_file file, 'DATABASE', 'test'
+
+    # Warn the user about file overwrite/creation
+    warn_file_update(file, exists)
+  end
+
+  def database_config(database)
+    case database
+    when 'mysql', 'mysql2'
+      { header: MYSQL_DOCKER_DB, host: 'mysql', adapter: 'mysql2' }
+    when 'postgres', 'postgresql'
+      { header: POSTGRES_DOCKER_DB, host: 'postgres', adapter: 'postgresql' }
+    else
+      raise 'Unknown database: either mysql or postgres'
+    end
+  end
+
+  def warn_file_update(file, exists)
+    intro = if exists
+              "/!\\ Watch out! Your #{file} was overwritten"
+            else
+              "A new file #{file} was added"
+            end
+
+    say "#{intro} by Modulorails. Ensure everything is correct!"
+  end
+
+  def create_keep_file
+    file = '.modulorails-gitlab-ci'
+
+    # Create file to avoid this generator on next modulorails launch
+    create_file(file)
+
+    say "Add #{file} to git"
+    %x(git add #{file})
+  end
+end

data/lib/generators/templates/.gitlab-ci.yml

@@ -0,0 +1,72 @@
+image: ruby:RUBY_VERSION
+stages:
+  - lint
+  - test
+  - deploy
+cache:
+  key: CI_CD_CACHE_KEY
+  paths:
+    - vendor/ruby
+
+before_script:
+  - apt-get update -qy
+  - 'which ssh-agent || ( apt-get update -y && apt-get install openssh-client -y )'
+  - eval $(ssh-agent -s)
+  - ssh-add <(echo "$SSH_PRIVATE_KEY")
+  - mkdir -p ~/.ssh
+  - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config'
+  - apt-get install -y ruby-dev
+  - gem install bundler -v BUNDLER_VERSION --no-document
+  # You might need DPL if you're deploying using Heroku
+  #- gem install dpl -v 1.10.15 --no-document
+  # You might need to add some configurations here like a key for a theme
+  #- bundle config gems.rapidrailsthemes.com "$RRT_CFG"
+  - bundle install -j $(nproc) --path vendor
+
+rubocop:
+  stage: lint
+  script:
+    - bundle exec rubocop -D
+  tags:
+    - rails
+  except:
+    - master
+    - staging
+
+test:
+  stage: test
+  script:
+    - cp config/database-ci.yml config/database.yml
+    - "bundle exec rake db:create RAILS_ENV=test"
+    - "RAILS_ENV=test bundle exec rake db:migrate:reset"
+    - bundle exec rspec
+  tags:
+    - rails
+  except:
+    - master
+
+staging:
+  stage: deploy
+  script:
+    # Uncomment the next line and update the application name if you're using DPL to deploy on
+    # Heroku
+    #- dpl --provider=heroku --app=APP_NAME --api-key=$HEROKU_API_KEY
+    # Remove the next line if you're not using Capistrano
+    - bundle exec cap staging deploy
+  only:
+    - staging
+  tags:
+    - rails
+
+production:
+  stage: deploy
+  script:
+    # Uncomment the next line and update the application name if you're using DPL to deploy on
+    # Heroku
+    #- dpl --provider=heroku --app=APP_NAME --api-key=$HEROKU_API_KEY
+    # Remove the next line if you're not using Capistrano
+    - bundle exec cap production deploy
+  only:
+    - master
+  tags:
+    - rails

data/lib/generators/templates/config/database-ci.yml

@@ -0,0 +1,7 @@
+test:
+  host: HOST
+  adapter: ADAPTER
+  database: DATABASE
+  username: root
+  password: password
+  encoding: utf8

data/lib/modulorails.rb

@@ -0,0 +1,126 @@
+require 'modulorails/version'
+require 'modulorails/configuration'
+require 'modulorails/data'
+require 'modulorails/validators/database_configuration'
+require 'modulorails/railtie' if defined?(Rails::Railtie)
+require 'generators/gitlabci_generator'
+require 'httparty'
+
+# Author: Matthieu 'ciappa_m' Ciappara
+# 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
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # When a block is given, it allows to define or update the current configuration. Without a
+    # block, this methods is just a configuration getter.
+    #
+    # @yield [configuration] Block with the current configuration; optional
+    # @yieldparam [Modulorails::Configuration] The current configuration
+    # @return [Modulorails::Configuration] The current configuration; updated if a block was given
+    def configure
+      # Get the current configuration if no block is given
+      return configuration unless block_given?
+
+      # Pass the configuration to the block and let the block do what it wants (probably update the
+      # configuration)
+      yield configuration
+
+      # Return the (probably updated) current configuration
+      configuration
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # A configuration getter.
+    #
+    # @return [Modulorails::Configuration] The current configuration
+    def configuration
+      @configuration ||= Modulorails::Configuration.new
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # A data getter.
+    #
+    # @return [Modulorails::Data] The current data
+    def data
+      @data ||= Modulorails::Data.new
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # Send the `#data` to the Intranet as JSON. HTTParty is used to send the POST request.
+    #
+    # @return [HTTParty::Response] The response of the intranet
+    # @raise [Modulorails::Error] If the endpoint or the API key of the intranet were not configured
+    def send_data
+      # 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
+
+        # 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 errors: #{response['errors'].join(', ')}") if response.code == 400
+
+        # Return the response to allow users to do some more
+        response
+      else
+        raise Error.new('No endpoint or api key')
+      end
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # 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'))
+
+      generator_options = [
+        '--app', data.rails_name.parameterize,
+        '--database', data.adapter,
+        '--bundler', data.bundler_version,
+        '--ruby_version', data.ruby_version
+      ]
+      GitlabciGenerator.new([], generator_options, {}).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 errors:')
+      invalid_rules.each do |rule|
+        puts("[Modulorails]    Invalid database configuration for rule: #{rule}")
+      end
+
+      false
+    end
+  end
+end

data/lib/modulorails/configuration.rb

@@ -0,0 +1,27 @@
+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
+
+    # This allows to define a DSL to configure the gem
+    # Example:
+    # Modulorails.configure do |config|
+    #   config.name 'MySuperApp'
+    #   config.main_developer 'dev@modulotech.fr'
+    #   config.project_manager 'pm@modulotech.fr'
+    #   config.endpoint "intranet's endpoint"
+    #   config.api_key "intranet's api key"
+    # end
+    %i[name main_developer project_manager endpoint api_key].each do |field|
+      define_method(field) do |value=nil|
+        # No value means we want to get the field
+        return send("_#{field}") unless value
+
+        # Else we want to set the field
+        send("_#{field}=", value)
+      end
+    end
+  end
+end

data/lib/modulorails/data.rb

@@ -0,0 +1,103 @@
+require 'rails'
+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
+    ].freeze
+
+    # Useful if the gem's user need to read one of the data
+    attr_reader *ATTRIBUTE_KEYS
+
+    def initialize
+      # 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
+      db_connection = ActiveRecord::Base.connection
+      # Get the gem's specifications to fetch the versions of critical gems
+      loaded_specs = Gem.loaded_specs
+
+      # The three 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
+
+      # 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')
+
+      # 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 Rails version used by the application
+      @rails_version = loaded_specs['rails'].version.version
+
+      # The bundler version used by the application (especially useful since Bundler 2 and
+      # Bundler 1 are not compatible)
+      @bundler_version = loaded_specs['bundler'].version.version
+
+      # The version of the gem
+      @modulorails_version = Modulorails::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 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 ActiveRecord adapter
+      @adapter_version = loaded_specs[@adapter]&.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(', ')
+    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'    => {
+          '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
+          }
+        }
+      }
+    end
+  end
+end

data/lib/modulorails/railtie.rb

@@ -0,0 +1,19 @@
+module Modulorails
+  class Railtie < ::Rails::Railtie
+    # Binding in the Rails lifecycle. Sending data after the initialization ensures we can access
+    # all gems and symbols we might have to use.
+    config.after_initialize do
+      # For now, we limit everything to the development environment
+      if Rails.env.development?
+        # Effectively send the data to the intranet
+        Modulorails.send_data
+
+        # Generate a template for CI/CD
+        Modulorails.generate_ci_template
+
+        # Check database configuration
+        Modulorails.check_database_config
+      end
+    end
+  end
+end

data/lib/modulorails/validators/database_configuration.rb

@@ -0,0 +1,93 @@
+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 false 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)
+
+        get_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
+
+        general + dev + test
+      end
+
+      def check_standard_config_file_location
+        # Load the configuration
+        config = Psych.load_file(Rails.root.join('config/database.yml'))
+
+        # If no exception was raised, then the database configuration file is at standard location
+        @rules[:standard_config_file_location] = true
+
+        config
+      rescue StandardError =>e
+        # 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)
+        test_eq_database                               = config['test']['database'] != config['development']['database']
+        @rules[:test_database_not_equals_dev_database] = test_eq_database
+      end
+
+      # Check all rules for an environment
+      def check_rules_for_environment(config, env)
+        @rules[env].keys.each 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

data/lib/modulorails/version.rb

@@ -0,0 +1,3 @@
+module Modulorails
+  VERSION = "0.1.0"
+end

data/modulorails.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/modulorails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'modulorails'
+  spec.version       = Modulorails::VERSION
+  spec.authors       = ['Matthieu Ciappara']
+  spec.email         = ['ciappa_m@modulotech.fr']
+
+  spec.summary       = 'Common base for Ruby on Rails projects at Modulotech'
+  spec.description   =<<~END_OF_TEXT
+    Modulorails is the common base for the Ruby on Rails project at Modulotech
+    (https://www.modulotech.fr/).
+
+    It registers each application using it on the company's intranet, provides templates for the
+    common configurations and defines common dependencies.
+  END_OF_TEXT
+  spec.homepage      = 'https://github.com/moduloTech/modulorails'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/moduloTech/modulorails/blob/master/CHANGELOG.md'
+
+  # 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
+    `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_development_dependency 'activerecord', '>= 4.2.0'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: modulorails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthieu Ciappara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: |
+  Modulorails is the common base for the Ruby on Rails project at Modulotech
+  (https://www.modulotech.fr/).
+
+  It registers each application using it on the company's intranet, provides templates for the
+  common configurations and defines common dependencies.
+email:
+- ciappa_m@modulotech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/gitlabci_generator.rb
+- lib/generators/templates/.gitlab-ci.yml
+- lib/generators/templates/config/database-ci.yml
+- lib/modulorails.rb
+- lib/modulorails/configuration.rb
+- lib/modulorails/data.rb
+- lib/modulorails/railtie.rb
+- lib/modulorails/validators/database_configuration.rb
+- lib/modulorails/version.rb
+- modulorails.gemspec
+homepage: https://github.com/moduloTech/modulorails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moduloTech/modulorails
+  source_code_uri: https://github.com/moduloTech/modulorails
+  changelog_uri: https://github.com/moduloTech/modulorails/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Common base for Ruby on Rails projects at Modulotech
+test_files: []