modulorails 0.2.2 → 1.0.1

data/lib/modulorails.rb

@@ -2,10 +2,16 @@ require 'modulorails/version'
 require 'modulorails/configuration'
 require 'modulorails/data'
 require 'modulorails/validators/database_configuration'
-require 'modulorails/updater'
 require 'modulorails/railtie' if defined?(Rails::Railtie)
-require 'generators/gitlabci_generator'
+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 'httparty'
+require 'modulorails/error_data'
+require 'modulorails/success_data'
+require 'modulorails/errors/errors'
+require 'modulorails/services/services'
 
 # Author: Matthieu 'ciappa_m' Ciappara
 # The entry point of the gem. It exposes the configurator, the gathered data and the method to
@@ -77,17 +83,25 @@ module Modulorails
         # 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] Error: #{response['errors'].join(', ')}") if response.code == 400
-
-        # Return the response to allow users to do some more
-        response
+        # 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
         raise Error.new('No endpoint or api key')
       end
@@ -100,13 +114,7 @@ module Modulorails
     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
+      Modulorails::GitlabciGenerator.new([], {}, {}).invoke_all
     end
 
     # @author Matthieu 'ciappa_m' Ciappara
@@ -130,9 +138,26 @@ module Modulorails
     # Check the last version of Modulorails available on rubygems and update if there was a
     # publication
     def self_update
-      Modulorails::Updater.call unless configuration.no_auto_update
+      Modulorails::SelfUpdateGenerator.new([], {}, {}).invoke_all unless configuration.no_auto_update
     rescue StandardError => e
       puts("[Modulorails] An error occured: #{e.class} - #{e.message}")
     end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # 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'))
+
+      Modulorails::HealthCheckGenerator.new([], {}, {}).invoke_all
+    end
+
+    # @author Matthieu 'ciappa_m' Ciappara
+    #
+    # Generate a rubocop configuration.
+    def generate_rubocop_template
+      Modulorails::RubocopGenerator.new([], {}, {}).invoke_all
+    end
   end
 end

data/modulorails.gemspec

@@ -33,6 +33,10 @@ Gem::Specification.new do |spec|
   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_development_dependency 'activerecord', '>= 4.2.0'
+  spec.add_development_dependency 'appraisal'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthieu Ciappara
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -28,22 +28,22 @@ dependencies:
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
         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: '1.7'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: health_check
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Modulorails is the common base for the Ruby on Rails project at Modulotech
   (https://www.modulotech.fr/).
@@ -98,28 +154,69 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile.ruby25
+- Dockerfile.ruby26
+- Dockerfile.ruby27
+- Dockerfile.ruby30
+- Dockerfile.ruby31
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/stylesheets/modulorails.css
+- app/helpers/modulorails/application_helper.rb
 - bin/console
 - bin/setup
 - config/locales/en.yml
-- lib/generators/gitlabci_generator.rb
-- lib/generators/templates/.gitlab-ci.yml
-- lib/generators/templates/.modulorails-gitlab-ci
-- lib/generators/templates/config/database-ci.yml
+- docker-compose.debug.yml
+- docker-compose.yml
+- entrypoints/appraisal_test.sh
+- gemfiles/rails_52.gemfile
+- gemfiles/rails_60.gemfile
+- gemfiles/rails_61.gemfile
+- gemfiles/rails_70.gemfile
+- lib/generators/modulorails/docker/docker_generator.rb
+- lib/generators/modulorails/docker/templates/Dockerfile.prod.tt
+- lib/generators/modulorails/docker/templates/Dockerfile.tt
+- lib/generators/modulorails/docker/templates/config/database.yml.tt
+- lib/generators/modulorails/docker/templates/docker-compose.prod.yml.tt
+- lib/generators/modulorails/docker/templates/docker-compose.yml.tt
+- lib/generators/modulorails/docker/templates/entrypoints/docker-entrypoint.sh.tt
+- lib/generators/modulorails/docker/templates/entrypoints/webpack-entrypoint.sh.tt
+- 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
+- lib/generators/modulorails/rubocop/rubocop_generator.rb
+- lib/generators/modulorails/rubocop/templates/rubocop.yml.tt
+- lib/generators/modulorails/self_update/self_update_generator.rb
+- lib/generators/modulorails/service/service_generator.rb
+- lib/generators/modulorails/service/templates/service.rb.tt
 - lib/modulorails.rb
 - lib/modulorails/configuration.rb
 - lib/modulorails/data.rb
+- lib/modulorails/error_data.rb
+- lib/modulorails/errors/base_error.rb
+- lib/modulorails/errors/errors.rb
+- lib/modulorails/errors/invalid_format_error.rb
+- lib/modulorails/errors/invalid_value_error.rb
 - lib/modulorails/railtie.rb
-- lib/modulorails/updater.rb
+- lib/modulorails/services/base_service.rb
+- lib/modulorails/services/logs_for_method_service.rb
+- lib/modulorails/services/services.rb
+- lib/modulorails/success_data.rb
 - lib/modulorails/validators/database_configuration.rb
 - lib/modulorails/version.rb
 - modulorails.gemspec
@@ -130,7 +227,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Common base for Ruby on Rails projects at Modulotech
 test_files: []

data/lib/generators/gitlabci_generator.rb

@@ -1,134 +0,0 @@
-# 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
-  rescue StandardError => e
-    $stderr.puts("[Modulorails] Error: cannot generate CI configuration: #{e.message}")
-  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 adapter `#{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
-    copy_file(file, file)
-
-    say "Add #{file} to git"
-    %x(git add #{file})
-  end
-end

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

@@ -1,72 +0,0 @@
-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/.modulorails-gitlab-ci

@@ -1,3 +0,0 @@
-This file ensures the modulorails gem will not try to override your current .gitlab-ci.yml file.
-
-You can remove this file if you want the generator to rewrite your .gitlab-ci.yml file.

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

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

data/lib/modulorails/updater.rb

@@ -1,46 +0,0 @@
-module Modulorails
-  # Author: Matthieu 'ciappa_m' Ciappara
-  # This updates modulorails by editing the gemfile and running a bundle update
-  class Updater
-    LATEST_VERSION_URL = 'https://rubygems.org/api/v1/versions/modulorails/latest.json'.freeze
-
-    def self.call(*args)
-      new(*args).call
-    end
-
-    def call
-      # Get the last published version
-      @last_published_version = HTTParty.get(LATEST_VERSION_URL).parsed_response['version']
-
-      # Do nothing if we could not fetch the last published version (whatever the reason)
-      # Or if the current version is the same as the last published version
-      return if @last_published_version.nil? || @last_published_version == Modulorails::VERSION
-
-      # If the last published version is different from the current version, we update the gem
-      edit_gemfile
-    end
-
-    private
-
-    def edit_gemfile
-      # Log to warn the user
-      puts("[Modulorails] Last version for modulorails is #{@last_published_version} while you "\
-        "are using version #{Modulorails::VERSION}. Running auto-update.")
-
-      # Read the lines of the Gemfile
-      gemfile_location = Rails.root.join('Gemfile')
-      lines            = File.readlines gemfile_location
-
-      # Search and replace the modulorails line
-      index = lines.index { |l| l =~ /gem\s['"]modulorails['"]/ }
-      lines[index].gsub!(/(\s*)gem\s['"]modulorails['"].*/,
-                         "#{$1}gem 'modulorails', '= #{@last_published_version}'")
-
-      # Update the Gemfile
-      File.open(gemfile_location, 'w') { |f| f.puts(lines) }
-
-      # Update the gem and the Gemfile.lock
-      system('bundle install')
-    end
-  end
-end