modulorails 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aebb014e4b73e3c0b3cd12106187db5592900f90ea33beb4bd80ffe7b54fba0
-  data.tar.gz: e84b4a5949cf657a3205b9f9b3edae7a7e1b0bc5621723eff5455d939199da5c
+  metadata.gz: 55dbb40ab0e717d0204e96ded91f37a2384d6a068cc588d4c4c9db90e96c2d91
+  data.tar.gz: e6f08f5aeec11a0249d8323604f17471120a066e696308c6ad9d0b2e4ed93cd7
 SHA512:
-  metadata.gz: c8abc2a6dc7bd6e6d344441bd16123f9a750a752732e02ae2826fd8a0a8ef0e5806cdde5da9da9b06d16a80fa414775d11fb657b90812c59350775b36db17a1c
-  data.tar.gz: af263b043c1c5ae69555b76ccf805d7567b0964eefe7748c96aad3aff2d66f9495e61025c8a51c242703e87bfc6e849e8accd69aafa1ab1ce2be35b8735cafde
+  metadata.gz: f4c82055e0f2037c6f4ff7831659be156ff501eb4fbe80ac52089f1857f20ff1db40e81446d0bf2bbfba1df6bba7638b05b54bb114623ff856eb9fce5cb65641
+  data.tar.gz: 79732d5ad59379f2988ac10d8dac50f99d1984365fca5487ead432cb8d7f2e1b39b666e344dc02f051c267ffe9da19dcc4a82785ecda669c638bed101ee23fe0

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/CHANGELOG.md

@@ -2,7 +2,20 @@
 
 This file is used to list changes made in each version of the gem.
 
-# 0.2.1
+# 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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    modulorails (0.2.2)
+    modulorails (0.3.0)
       git (~> 1.7, >= 1.7.0)
       httparty
       i18n
@@ -53,11 +53,9 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0225)
-    mini_portile2 (2.5.0)
     minitest (5.14.1)
     multi_xml (0.6.0)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.1-x86_64-darwin)
       racc (~> 1.4)
     racc (1.5.2)
     rack (2.2.3)

data/lib/generators/docker/docker_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class DockerGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates Dockerfiles for an app'
+
+  def create_config_file
+    template 'Dockerfile'
+    template 'Dockerfile.prod'
+    template 'docker-compose.yml'
+    template 'docker-compose.prod.yml'
+    template 'entrypoints/docker-entrypoint.sh'
+    template 'config/database.yml'
+  rescue StandardError => e
+    $stderr.puts("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
+  end
+end

data/lib/generators/docker/templates/Dockerfile.prod.tt

@@ -0,0 +1,52 @@
+FROM surnet/alpine-wkhtmltopdf:3.12-0.12.6-small as wkhtmltopdf
+# BUILD IMAGE
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine as builder
+
+ENV RAILS_ENV=production
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    mysql-dev \
+    nodejs \
+    sqlite-dev \
+    tzdata \
+    yarn \
+    shared-mime-info
+RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle check || bundle install --deployment --jobs=2 \
+    && rm -rf vendor/bundle/ruby/*/cache/*
+
+COPY package.json yarn.lock ./
+RUN yarn install
+
+COPY . .
+RUN bundle exec rake assets:precompile
+
+# FINAL IMAGE
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    curl \
+    git \
+    mysql-dev \
+    nodejs \
+    sqlite-dev \
+    tzdata \
+    shared-mime-info
+    && rm -rf .git/
+
+# Replace segfault version with patched one
+COPY --from=wkhtmltopdf /bin/wkhtmltopdf /usr/bin/wkhtmltopdf
+COPY --from=builder /app .
+
+RUN bundle config --local path vendor/bundle \
+    && bundle config --local without development:test:assets
+
+EXPOSE 3000
+
+ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

data/lib/generators/docker/templates/Dockerfile.tt

@@ -0,0 +1,28 @@
+# Import wkhtmltopdf with qt patched because from alpine it's not and segfault
+FROM surnet/alpine-wkhtmltopdf:3.12-0.12.6-small as wkhtmltopdf
+
+FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
+
+ENV RAILS_ENV=development
+WORKDIR /app
+
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    nodejs \
+    yarn \
+    sqlite-dev \
+    tzdata \
+    mysql-dev
+RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
+
+COPY Gemfile Gemfile.lock ./
+RUN bundle install --jobs=2
+
+COPY . .
+
+# Replace segfault version with patched one
+COPY --from=wkhtmltopdf /bin/wkhtmltopdf /usr/bin/wkhtmltopdf
+
+EXPOSE 3000
+
+ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

data/lib/generators/docker/templates/config/database.yml.tt

@@ -0,0 +1,21 @@
+<%- image_name = Modulorails.data.name.parameterize -%>
+<%- upper_image_name = image_name.upcase -%>
+development: &default
+  adapter: mysql2
+  encoding: utf8mb4
+  collation: utf8mb4_unicode_ci
+  database: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_NAME', '<%= image_name %>') %>
+  username: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_USERNAME', 'root') %>
+  password: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PASSWORD', '') %>
+  host: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 3306) %>
+
+test:
+  <<: *default
+  database: <%%= ENV.fetch('<%= upper_image_name %>_TEST_DATABASE_NAME', '<%= image_name %>_test') %>
+
+staging:
+  <<: *default
+
+production:
+  <<: *default

data/lib/generators/docker/templates/docker-compose.prod.yml.tt

@@ -0,0 +1,36 @@
+version: '3.7'
+
+<% image_name = Modulorails.data.name.parameterize %>
+
+services:
+  app:
+    image: modulotechgroup/<%=  image_name %>
+    build:
+      context: .
+      dockerfile: Dockerfile.prod
+    depends_on:
+      - database
+      - redis
+    ports:
+      - '3000:3000'
+    environment:
+      RAILS_ENV: production
+      URL: http://localhost:3000
+      <%= image_name.upcase %>_DATABASE_HOST: database
+      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      RAILS_SERVE_STATIC_FILES: 'true'
+
+  database:
+    image: mysql:8.0
+    volumes:
+      - db_data:/var/lib/mysql
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      MYSQL_DATABASE: <%= image_name %>
+
+  redis:
+    image: redis:6.2-alpine
+
+# Define the volumes references in the services
+volumes:
+  db_data:

data/lib/generators/docker/templates/docker-compose.yml.tt

@@ -0,0 +1,37 @@
+version: '3.7'
+
+<% image_name = Modulorails.data.name.parameterize %>
+
+services:
+  app:
+    image: modulotechgroup/<%= image_name %>:dev
+    build:
+      context: .
+      dockerfile: Dockerfile
+    depends_on:
+      - database
+      - redis
+    ports:
+      - '3000:3000'
+    volumes:
+      - .:/app
+    environment:
+      RAILS_ENV: development
+      URL: http://localhost:3000
+      <%= image_name.upcase %>_DATABASE_HOST: database
+      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+    entrypoint: ./entrypoints/docker-entrypoint.sh
+
+  database:
+    image: mysql:8.0
+    volumes:
+      - db_data:/var/lib/mysql
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      MYSQL_DATABASE: <%= image_name %>
+
+  redis:
+    image: redis:6.2-alpine
+
+volumes:
+  db_data:

data/lib/generators/docker/templates/entrypoints/docker-entrypoint.sh.tt

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# No `node_modules` directory means `yarn install` was never launched.
+# It is mandatory to install yarn dependencies.
+if [ ! -d node_modules ]
+then
+  yarn install
+fi
+
+# Remove pidfile if it exists else the server will not launch
+if [ -f tmp/pids/server.pid ]
+then
+  rm tmp/pids/server.pid
+fi
+
+# Launch the application listening from all origins on port 3000
+./bin/bundle exec rails s -b 0.0.0.0 -p 3000

data/lib/generators/gitlabci/gitlabci_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class GitlabciGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  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
+    # Update the gitlab-ci template
+    template '.gitlab-ci.yml'
+
+    # Update the database-ci template
+    template 'config/database-ci.yml'
+
+    # 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 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 → gitlabci/templates/.gitlab-ci.yml.tt}

@@ -1,10 +1,17 @@
-image: ruby:RUBY_VERSION
+<%- adapter = Modulorails.data.adapter -%>
+<%- if adapter =~ /mysql/ -%>
+<%= GitlabciGenerator::MYSQL_DOCKER_DB -%>
+<%- else -%>
+<%= GitlabciGenerator::POSTGRES_DOCKER_DB -%>
+<%- end -%>
+
+image: ruby:<%= Modulorails.data.ruby_version %>
 stages:
   - lint
   - test
   - deploy
 cache:
-  key: CI_CD_CACHE_KEY
+  key: <%= Modulorails.data.rails_name.parameterize %>-ci_cd
   paths:
     - vendor/ruby
 
@@ -16,7 +23,7 @@ before_script:
   - 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
+  - gem install bundler -v <%= Modulorails.data.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

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

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

data/lib/modulorails.rb

@@ -4,7 +4,7 @@ require 'modulorails/data'
 require 'modulorails/validators/database_configuration'
 require 'modulorails/updater'
 require 'modulorails/railtie' if defined?(Rails::Railtie)
-require 'generators/gitlabci_generator'
+require 'generators/gitlabci/gitlabci_generator'
 require 'httparty'
 
 # Author: Matthieu 'ciappa_m' Ciappara
@@ -100,13 +100,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
+      GitlabciGenerator.new([], {}, {}).invoke_all
     end
 
     # @author Matthieu 'ciappa_m' Ciappara

data/lib/modulorails/railtie.rb

@@ -18,7 +18,7 @@ module Modulorails
         Modulorails.check_database_config
 
         # Gem's self-update if a new version was released
-        Modulorails.self_update
+        # Modulorails.self_update
       end
     end
   end

data/lib/modulorails/version.rb

@@ -1,3 +1,3 @@
 module Modulorails
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -111,10 +111,17 @@ files:
 - 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
+- lib/generators/docker/docker_generator.rb
+- lib/generators/docker/templates/Dockerfile.prod.tt
+- lib/generators/docker/templates/Dockerfile.tt
+- lib/generators/docker/templates/config/database.yml.tt
+- lib/generators/docker/templates/docker-compose.prod.yml.tt
+- lib/generators/docker/templates/docker-compose.yml.tt
+- lib/generators/docker/templates/entrypoints/docker-entrypoint.sh.tt
+- lib/generators/gitlabci/gitlabci_generator.rb
+- lib/generators/gitlabci/templates/.gitlab-ci.yml.tt
+- lib/generators/gitlabci/templates/.modulorails-gitlab-ci
+- lib/generators/gitlabci/templates/config/database-ci.yml.tt
 - lib/modulorails.rb
 - lib/modulorails/configuration.rb
 - lib/modulorails/data.rb

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/config/database-ci.yml

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