modulorails 0.2.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aebb014e4b73e3c0b3cd12106187db5592900f90ea33beb4bd80ffe7b54fba0
-  data.tar.gz: e84b4a5949cf657a3205b9f9b3edae7a7e1b0bc5621723eff5455d939199da5c
+  metadata.gz: d9c1a33ace09742eb134cb8f41cf1aaac6f6687c8e9df97c91190aec0ca23034
+  data.tar.gz: 22e48b8dd51a0f187abc8a76f95af35224b6666b41b55851ef77a5a8a98d2450
 SHA512:
-  metadata.gz: c8abc2a6dc7bd6e6d344441bd16123f9a750a752732e02ae2826fd8a0a8ef0e5806cdde5da9da9b06d16a80fa414775d11fb657b90812c59350775b36db17a1c
-  data.tar.gz: af263b043c1c5ae69555b76ccf805d7567b0964eefe7748c96aad3aff2d66f9495e61025c8a51c242703e87bfc6e849e8accd69aafa1ab1ce2be35b8735cafde
+  metadata.gz: '08b2eb1496c1c61f30674449f5f0c56c773203851559b83b38c2c0cbf2dc55b88e89fcdece0f9d0b4a8264cc6baeef50d9b42f5bd2b67ad953bfb6d884e15881'
+  data.tar.gz: e21f3ac1ba44ebfc00776ca0f04541bf97e505f0773f5f47a8c2e5299909f0339f2769c1478ebce043935751a282373a0940bef910fb96bd271e857a7155e6c5

data/.dockerignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+gemfiles/*.lock
+Gemfile.lock

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem
+gemfiles/*.lock
+/config/database.yml

data/.rubocop.yml

@@ -0,0 +1,62 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+# Enabling Rails-specific cops.
+require: rubocop-rails
+
+AllCops:
+  # Disable all cops by default to ease the migration. This will probably be removed one day.
+  DisabledByDefault: true
+  # No suggestions since the gem is the sole truth for rubocop configuration.
+  SuggestExtensions: false
+
+  # Excluding most directories with generated files and directories with configuration files.
+  Exclude:
+    - 'vendor/**/*'
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'bin/**/*'
+    - 'builds/**/*'
+    - 'Gemfile'
+    - 'config/environments/*'
+    - 'config/puma.rb'
+    - 'config/spring.rb'
+    - 'test/application_system_test_case.rb'
+    - 'test/test_helper.rb'
+    - 'config/initializers/*.rb'
+    - 'spec/spec_helper.rb'
+    - '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

data/.travis.yml

@@ -1,9 +1,28 @@
 ---
 language: ruby
 cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
+
+ruby:
+  - '2.5'
+  - '2.6'
+  - '2.7'
+  - '3.0'
+  - '3.1'
+
 before_install:
   - gem install bundler -v 2.1.4
+
+gemfile:
+  - gemfiles/rails_52.gemfile
+  - gemfiles/rails_60.gemfile
+  - gemfiles/rails_61.gemfile
+  - gemfiles/rails_70.gemfile
+
+matrix:
+  exclude:
+    - gemfile: gemfiles/rails_70.gemfile
+      ruby: 2.5
+    - gemfile: gemfiles/rails_70.gemfile
+      ruby: 2.6
+
+script: bundle exec rake spec

data/Appraisals

@@ -0,0 +1,18 @@
+appraise "rails-52" do
+  gem 'rails', '~> 5.2', '>= 5.2.6'
+end
+
+appraise "rails-60" do
+  gem 'rails', '~> 6.0', '>= 6.0.4.4'
+end
+
+appraise "rails-61" do
+  gem 'rails', '~> 6.1', '>= 6.1.4.4'
+end
+
+# Rails 7 requires at least Ruby 2.7
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
+    appraise "rails-70" do
+      gem 'rails', '~> 7.0'
+    end
+end

data/CHANGELOG.md

@@ -2,7 +2,48 @@
 
 This file is used to list changes made in each version of the gem.
 
-# 0.2.1
+# 1.0.1
+
+First Rubocop rules.
+
+- Add Style/StringLiterals, Style/QuotedSymbols and Lint/SymbolConversion.
+
+# 1.0.0
+
+The Rubocop release.
+
+- Add Modulorails helper `powered_by`.
+- Add `Modulorails::BaseService`, `Modulorails::LogsForMethodService`,
+  `Modulorails::SuccessData` and `Modulorails::ErrorData`.
+- Add Rubocop dependency with empty configuration.
+- Ensure the compatibility of the gem with Ruby 3.0 and Ruby 3.1.
+
+# 0.4.0
+
+Fixes, updates and health_check release.
+
+- Update generators for Docker and Gitlab CI.
+- Move all generators under the `modulorails` namespace.
+- Add dependency to `health_check` gem.
+- Fix error on database configuration validator when no database.yml exists.
+- Rescue if httparty can't post to configuration.endpoint.
+- Add dockerfiles to test on many Ruby versions.
+- Add appraisal to test on many Rails versions.
+
+# 0.3.0
+
+Docker release.
+
+- Add generator for Docker.
+- Use templates for Gitlabci generator. 
+
+# 0.2.3
+
+Gitlab-ci generator.
+
+- Fixes the Ruby version put in the generated `.gitlab-ci.yml`.
+
+# 0.2.2
 
 Auto-update fixes.
 

data/Dockerfile.ruby25

@@ -0,0 +1,34 @@
+#
+# BUILD IMAGE
+#
+FROM ruby:2.5-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    tzdata
+
+RUN gem install bundler
+
+# Your RubyGems version (3.0.3)) has a bug that prevents `required_ruby_version` from working for
+# Bundler. Any scripts that use `gem install bundler` will break as soon as Bundler drops support
+# for your Ruby version. Please upgrade RubyGems to avoid future breakage and silence this warning
+# by running `gem update --system 3.2.3`
+RUN gem update --system 3.2.3
+
+COPY . .
+
+RUN bundle config set specific_platform true
+
+# Ensure the use of a Gemfile working with Ruby 2.5
+RUN sed -e 's/"..\/"/".\/"/' gemfiles/rails_52.gemfile > Gemfile
+
+# Install the basic dependencies
+RUN bundle install
+
+# Install dependencies for all supported Rails versions
+RUN bundle exec appraisal install
+
+# Run the tests
+CMD ['./entrypoints/appraisal_test.sh']

data/Dockerfile.ruby26

@@ -0,0 +1,28 @@
+#
+# BUILD IMAGE
+#
+FROM ruby:2.6-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    tzdata
+
+RUN gem install bundler
+
+COPY . .
+
+RUN bundle config set specific_platform true
+
+# Ensure the use of a Gemfile working with Ruby 2.6
+RUN sed -e 's/"..\/"/".\/"/' gemfiles/rails_52.gemfile > Gemfile
+
+# Install the basic dependencies
+RUN bundle install
+
+# Install dependencies for all supported Rails versions
+RUN bundle exec appraisal install
+
+# Run the tests
+CMD ['./entrypoints/appraisal_test.sh']

data/Dockerfile.ruby27

@@ -0,0 +1,25 @@
+#
+# BUILD IMAGE
+#
+FROM ruby:2.7-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    tzdata
+
+RUN gem install bundler
+
+COPY . .
+
+RUN bundle config set specific_platform true
+
+# Install the basic dependencies
+RUN bundle install
+
+# Install dependencies for all supported Rails versions
+RUN bundle exec appraisal install
+
+# Run the tests
+CMD ['./entrypoints/appraisal_test.sh']

data/Dockerfile.ruby30

@@ -0,0 +1,25 @@
+#
+# BUILD IMAGE
+#
+FROM ruby:3.0-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    tzdata
+
+RUN gem install bundler
+
+COPY . .
+
+RUN bundle config set specific_platform true
+
+# Install the basic dependencies
+RUN bundle install
+
+# Install dependencies for all supported Rails versions
+RUN bundle exec appraisal install
+
+# Run the tests
+CMD ['./entrypoints/appraisal_test.sh']

data/Dockerfile.ruby31

@@ -0,0 +1,25 @@
+#
+# BUILD IMAGE
+#
+FROM ruby:3.1-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    tzdata
+
+RUN gem install bundler
+
+COPY . .
+
+RUN bundle config set specific_platform true
+
+# Install the basic dependencies
+RUN bundle install
+
+# Install dependencies for all supported Rails versions
+RUN bundle exec appraisal install
+
+# Run the tests
+CMD ['./entrypoints/appraisal_test.sh']

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    modulorails (0.2.2)
+    modulorails (0.4.0)
       git (~> 1.7, >= 1.7.0)
+      health_check (~> 3.1)
       httparty
       i18n
       railties (>= 4.2.0)
@@ -10,99 +11,103 @@ PATH
 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)
+    actionpack (7.0.0)
+      actionview (= 7.0.0)
+      activesupport (= 7.0.0)
+      rack (~> 2.0, >= 2.2.0)
       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)
+    actionview (7.0.0)
+      activesupport (= 7.0.0)
       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)
+    activemodel (7.0.0)
+      activesupport (= 7.0.0)
+    activerecord (7.0.0)
+      activemodel (= 7.0.0)
+      activesupport (= 7.0.0)
+    activesupport (7.0.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     erubi (1.10.0)
-    git (1.8.1)
+    git (1.10.2)
       rchardet (~> 1.8)
-    httparty (0.18.1)
+    health_check (3.1.0)
+      railties (>= 5.0)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.8.5)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    mini_portile2 (2.5.0)
-    minitest (5.14.1)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
     multi_xml (0.6.0)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.13.1-aarch64-linux)
       racc (~> 1.4)
-    racc (1.5.2)
+    racc (1.6.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)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (7.0.0)
+      actionpack (= 7.0.0)
+      activesupport (= 7.0.0)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     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)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    thor (1.1.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
 
 PLATFORMS
-  ruby
+  aarch64-linux
 
 DEPENDENCIES
   activerecord (>= 4.2.0)
+  appraisal
   modulorails!
   rake (~> 12.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.3.3

data/README.md

@@ -10,7 +10,7 @@ provides templates for the common configurations and defines common dependencies
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'modulorails', git: 'git://github.com/moduloTech/modulorails.git'
+gem 'modulorails'
 ```
 
 And then execute:
@@ -33,9 +33,21 @@ 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).
+There are tests in `spec`. To run tests:
+- Build Docker images using `docker compose build`.
+- You can run tests on all supported Ruby versions using `docker compose up`.
+- Or you can run test on a specific Ruby version using one of the following commands:
+  - Ruby 2.5: `docker compose run ruby25`
+  - Ruby 2.6: `docker compose run ruby26`
+  - Ruby 2.7: `docker compose run ruby27`
+  - Ruby 3.0: `docker compose run ruby30`
+  - Ruby 3.1: `docker compose run ruby31`
+
+[Appraisal](https://github.com/thoughtbot/appraisal) is used to test the gem against many supported Rails versions:
+  - Rails 5.2, 6.0 and 6.1 on Ruby 2.5 and 2.6. 
+  - Rails 5.2, 6.0, 6.1 and 7.0 on Ruby 2.7, 3.0 and 3.1. 
+
+Travis CI is configured to automatically run tests in all supported Ruby versions and dependency sets after each push.
 
 ## Contributing
 

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/app/assets/stylesheets/modulorails.css

@@ -0,0 +1,21 @@
+/**
+ ** Modulorails style
+**/
+.modulolink {
+    text-decoration: none;
+    font-weight: 500;
+    color: #202D4C;
+}
+
+.modulolink span {
+    color: #FFCE19;
+}
+
+.modulolink:hover {
+    color: #374D82;
+    text-decoration: none;
+}
+
+.modulolink:hover span {
+    color: #FFCB0C;
+}

data/app/helpers/modulorails/application_helper.rb

@@ -0,0 +1,8 @@
+# @author Matthieu CIAPPARA <ciappa_m@modulotech.fr>
+module Modulorails::ApplicationHelper
+  def powered_by
+    link_to('https://www.modulotech.fr/', target: '_blank', class: 'modulolink') do
+      raw("Powered by modulo<span>Tech</span>")
+    end
+  end
+end

data/config/locales/en.yml

@@ -14,3 +14,6 @@ en:
       configurable_password: Password is not configurable for test environment
       configurable_database: Database name is not configurable for test environment
       configurable_port: Port is not configurable for test environment
+    errors:
+      invalid_format: Invalid format for field %{field}
+      invalid_value: Invalid value for field %{field}

data/docker-compose.debug.yml

@@ -0,0 +1,47 @@
+version: '3.7'
+
+services:
+  ruby25:
+    image: modulotechgroup/modulorails:testruby25
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby25
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby26:
+    image: modulotechgroup/modulorails:testruby26
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby26
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby27:
+    image: modulotechgroup/modulorails:testruby27
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby27
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby30:
+    image: modulotechgroup/modulorails:testruby30
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby30
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby31:
+    image: modulotechgroup/modulorails:testruby31
+    volumes:
+      - .:/app
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby31
+    command: ./entrypoints/appraisal_test.sh

data/docker-compose.yml

@@ -0,0 +1,37 @@
+version: '3.7'
+
+services:
+  ruby25:
+    image: modulotechgroup/modulorails:testruby25
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby25
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby26:
+    image: modulotechgroup/modulorails:testruby26
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby26
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby27:
+    image: modulotechgroup/modulorails:testruby27
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby27
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby30:
+    image: modulotechgroup/modulorails:testruby30
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby30
+    command: ./entrypoints/appraisal_test.sh
+
+  ruby31:
+    image: modulotechgroup/modulorails:testruby31
+    build:
+      context: .
+      dockerfile: Dockerfile.ruby31
+    command: ./entrypoints/appraisal_test.sh