dockerize-stack 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463c73cd30ce0f03ffbdeeffa99db4a7eedda9ac3611bd5c9e7ac8d477cc3d97
-  data.tar.gz: 7ec780a8f81ba600fc3e29a10456c8412c0cdaf8784dd99cb6476c3f86a7db5c
+  metadata.gz: b499b28348c817d3cb4684f8579183faf30a7b8262b95cb98c1b9a9535ecb3ee
+  data.tar.gz: 53f0fd0799c0db54c79844fe01c27f48b4b8e1ebd6a8058dd65fbaa9bbaa942a
 SHA512:
-  metadata.gz: 5927bd9855ff172132ae13ded16c2b0a77ab46f7d8e5b81cee01fc0e81ca558ad2685ff6691e1b11246b4db8f4d6934bd2113384dd20b7d5137f80c9466489c1
-  data.tar.gz: 7572551ff734743ba341b0b0ea7408018571bacaf502b7e92c2cb341130535e8c58bb36623b446a15c24efd1d8c67103307a657135e3a6f7b75c1628979ff5e7
+  metadata.gz: '008333cf81fc7cd01a5b870ff29cea94ed9b3fe5cffd049861896f5fa435ebdf9e5622b0f9907bbf69b54e2ee721bf91db153c9f5b389e505355e0ddce0da93f'
+  data.tar.gz: fab9fbc02cd471508f0e0b00f7d1a890b2d4fcfba872299def2ffa1eec041f1cd847eed800c6a93a4f3b1c9bbd63afaeba9131d6c824a3143b7da68803fab871

data/README.md

@@ -1,16 +1,12 @@
 # Dockerize Stack
 
-This it's a generator for generate Dockerfile and docker-compose for your application for development and production
+This it's a generator for generate Dockerfile and docker-compose for your application
 
 ## Why?
 
 - Help to configure multiple applications using the same templates.
 
-- For build a quick stack for your development enviroment docker is the best tool you can use, but you need to configure the Dockerfile docker-compose, persisted database data, set the entrypoint...
-
-- For deploy to kubernetes you need first Dockerfile for your application, this templates help to build optimize docker image for productions enviroments.
-
-- Using templates is more easy customize docker build process (Dockerfile, docker-compose).
+- Using templates is more easy to dockerize diferent type of projects.
 
 ## Install
 
@@ -40,22 +36,20 @@ docker run --user $(id -u) -it -v $(pwd):/usr/src devmasx/dockerize-stack rails
 
 [rails example](./examples/rails)
 
-By default the Dockerfile config is for production enviroment; using docker multistage feature and ARG (Build arguments) at the build time this Dockerfile is the same for development and production.
-
 See all options:
 
 ```
-dockerize-stack help rails
-```
-
-Build a docker image for development enviroment:
-
-```
-docker build -t rails-example \
- --build-arg=BUNDLE_DEPLOYMENT="false" \
- --build-arg=BUNDLE_WITHOUT="" \
- --build-arg=NODE_ENV="" \
- .
+Options:
+  t, [--template-folder=TEMPLATE_FOLDER]                       # Template folder path
+  o, [--output-folder=OUTPUT_FOLDER]                           # Output folder
+                                                               # Default: .
+      [--ruby-version=RUBY_VERSION]                            # Ruby Version (default 2.5.6):
+      [--nodejs-version=NODEJS_VERSION]                        # Nodejs version (default 10.16.3):
+      [--javascrit-package-manager=JAVASCRIT_PACKAGE_MANAGER]  # What is your Javascript package manager?
+      [--database=DATABASE]                                    # What is your Database?
+      [--rails-worker=RAILS_WORKER]                            # You need workers with sidekiq? y/n, (default y)
+      [--github-private=GITHUB_PRIVATE]                        # You need github token for private gems? y/n (default no)
+      [--kubernetes=KUBERNETES]                                # You want generate docker-stack for kubernetes? y/n (default no)
 ```
 
 ## TODO

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pry'
+require_relative '../lib/dockerize_stack'
+
+Pry.start

data/bin/dockerize-stack

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../lib/dockerize_stack'
 DockerizeStack::Command.start(ARGV)

data/lib/config.yml

@@ -1,28 +1,56 @@
 rails:
-  defaults:
-    ruby_version: "2.5.6"
-    nodejs_version: "10.16.3"
-    yarn_version: "1.17.3"
-    javascrit_package_manager:
-      - asset_pipeline
-      - yarn
-      - npm
-    database:
-      - postgresql
-      - mysql
-    rails_worker: true
-    github_private: false
-    kubernetes: false
   questions:
-    ruby_version: "Ruby Version (default 2.5.6):"
-    javascrit_package_manager: What is your Javascript package manager?
-    database: What is your Database?
-    rails_worker: You need workers with sidekiq? y/n, (default y)
-    github_private: You need github token for private gems? y/n (default no)
-    kubernetes: You want generate docker-stack for kubernetes? y/n (default no)'
+    - option: ruby_version
+      title: "Ruby Version (default 2.5.6):"
+      description: Ruby version
+      default: "2.5.6"
+      type: ask_with_default
+
+    - option: nodejs_version
+      title: "Nodejs version (default 10.16.3):"
+      default: "10.16.3"
+      type: with_default
+
+    - option: javascrit_package_manager
+      title: What is your Javascript package manager?
+      description: Select the package manager for Javascript modules
+      default: "yarn"
+      type: ask_with_options
+      ask_options:
+        - asset_pipeline
+        - yarn
+        - npm
+
+    - option: database
+      title: What is your Database?
+      description: Database type
+      default: "postgresql"
+      type: ask_with_options
+      ask_options:
+        - postgresql
+        - mysql
+
+    - option: rails_worker
+      title: You need workers with sidekiq? y/n, (default y)
+      description: Rails sidekiq examples in docker-compose.yml
+      default: "y"
+      type: ask_with_default_boolean
+
+    - option: github_private
+      title: You need github token for private gems? y/n (default no)
+      description: Set GITHUB_USERNAME and GITHUB_TOKEN in dockerfile bundle config
+      default: "y"
+      type: ask_with_default_boolean
+
+    - option: kubernetes
+      title: You want generate docker-stack for kubernetes? y/n (default no)
+      description: Basic examples for kubernetes config (minikube)
+      default: "n"
+      type: ask_with_default_boolean
 
 react:
-  defaults:
-    nodejs_version: "10.16.3"
   questions:
-    nodejs_version: "Nodejs version (default 10.16.3):"
+    - option: nodejs_version
+      title: "Nodejs version (default 10.16.3):"
+      default: "10.16.3"
+      type: ask_with_default

data/lib/dockerize_stack.rb

@@ -1,13 +1,12 @@
+# frozen_string_literal: true
+
 require 'thor'
 require_relative './thor_extend.rb'
-require_relative './dockerize_stack/react.rb'
-require_relative './dockerize_stack/rails.rb'
 
 module DockerizeStack
   class Command < Thor
     include Thor::Actions
     include ThorActionsExtend
-    RAILS_CONFIG_DEFAULTS = CONFIG.dig(:rails, :defaults)
 
     option :template_folder,
            aliases: 't',
@@ -16,38 +15,26 @@ module DockerizeStack
            default: '.',
            aliases: 'o',
            desc: 'Output folder'
-    option :ruby_version,
-           banner: RAILS_CONFIG_DEFAULTS[:ruby_version],
-           desc: 'Ruby version'
-    option :javascrit_package_manager,
-           banner: 'npm',
-           enum: RAILS_CONFIG_DEFAULTS[:javascrit_package_manager]
-    option :nodejs_version,
-           banner: RAILS_CONFIG_DEFAULTS[:nodejs_version],
-           desc: 'Nodejs version'
-    option :yarn_version,
-           banner: RAILS_CONFIG_DEFAULTS[:yarn_version],
-           desc: 'Yarn version'
-    option :database,
-           banner: 'postgresql',
-           enum: RAILS_CONFIG_DEFAULTS[:database],
-           desc: 'Database type'
-    option :rails_worker,
-           type: :boolean,
-           banner: RAILS_CONFIG_DEFAULTS[:rails_worker],
-           desc: 'Rails sidekiq examples in docker-compose.yml'
-    option :github_private,
-           type: :boolean,
-           banner: RAILS_CONFIG_DEFAULTS[:github_private],
-           desc: 'Set GITHUB_USERNAME and GITHUB_TOKEN in dockerfile bundle config'
-    option :kubernetes,
-           type: :boolean,
-           banner: RAILS_CONFIG_DEFAULTS[:kubernetes],
-           desc: 'Basic examples for kubernetes config (minikube)'
+
+    CONFIG[:rails][:questions].each do |question|
+      option question[:option],
+             desc: question[:title]
+    end
 
     desc 'rails', 'generate docker files for rails application'
     def rails
-      DockerizeStack::Rails.new.run(options)
+      run(options, :rails)
+      all_file_paths(:rails).each do |file_path|
+        if file_path =~ %r{./templates/rails/kubernetes} && !@kubernetes
+          return false
+        end
+
+        file_name = file_path.gsub('/templates/rails', '')
+        template file_name, "#{@output_folder}/#{file_name.gsub('.erb', '')}"
+      end
+      render_template! '.dockerignore.erb'
+
+      puts 'Update your database.yml based in database-docker.yml'
     end
 
     option :template_folder, aliases: 't', desc: 'Template folder path'
@@ -56,7 +43,12 @@ module DockerizeStack
 
     desc 'react', 'generate docker files for create react app'
     def react
-      DockerizeStack::React.new.run(options)
+      run(options, :react)
+      all_file_paths(:react).each do |file_path|
+        file_name = file_path.gsub('/templates/react', '')
+        template file_name, "#{@output_folder}/#{file_name.gsub('.erb', '')}"
+      end
+      render_template! '.dockerignore.erb'
     end
   end
 end

data/lib/thor_extend.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 
@@ -5,59 +7,67 @@ module ThorActionsExtend
   include Thor::Actions
 
   CONFIG = JSON.parse(
-      JSON.dump(YAML.load_file("#{File.dirname(__FILE__)}/config.yml")),
-      symbolize_names: true
-    )
-  def run(options)
+    JSON.dump(YAML.load_file("#{File.dirname(__FILE__)}/config.yml")),
+    symbolize_names: true
+  )
+
+  def run(options, template_type)
     @template_type = template_type
     @options = options
+    @output_folder = options['output_folder']
     @config = CONFIG[@template_type]
-    self.class.source_root(template_folder(@template_type.to_s))
+    self.class.source_root(template_folder)
 
     fetch_template_variables
-    render_templates
-  end
-
-  private
-
-  def template_folder(template_type)
-    @options[:template_folder] || "#{File.dirname(__FILE__)}/../templates/#{template_type}"
-  end
-
-  def render_template(path, target_path = path)
-    template path, "#{@output_folder}/#{target_path.gsub('.erb', '')}"
   end
 
-  def with_default(option)
-    return @config[:defaults][option] if @options[option].nil?
-
-    @options[option]
+  def fetch_template_variables
+    @config[:questions].each do |question|
+      default = question[:default]
+      option = question[:option]
+      title = question[:title]
+      type = question[:type]
+
+      if @options[option] || @options[option] == false
+        instance_variable_set("@#{option}", @options[option])
+        next
+      end
+
+      case type
+      when 'with_default'
+        instance_variable_set("@#{option}", default)
+      when 'ask_with_default'
+        result = ask(title)
+        result == '' ? default : result
+
+        instance_variable_set("@#{option}", result)
+      when 'ask_with_default_boolean'
+        result = ask(title)
+        result = default if result == ''
+        result = %w[yes y true].include?(result) ? true : false
+
+        instance_variable_set("@#{option}", result)
+      when 'ask_with_options'
+        instance_variable_set("@#{option}", ask(title, limited_to: question[:ask_options]))
+      else
+        raise "Invalid question type: #{type}"
+      end
+    end
   end
 
-  def ask_with_default(option, default = nil)
-    return @options[option] unless @options[option].nil?
-
-    default = @config[:defaults][option] if default.nil?
-    result = ask(@config[:questions][option])
+  private
 
-    result == '' ? default : result
+  def render_template!(template_file)
+    result = ERB.new(File.read("#{template_folder}/#{template_file}")).result(binding)
+    File.write("#{@output_folder}/#{template_file.gsub('.erb', '')}", result)
   end
 
-  def ask_with_options(option, limited_to = nil)
-    return @options[option] if @options[option]
-
-    limited_to = @config[:defaults][option] if limited_to.nil?
-    ask(@config[:questions][option], limited_to: limited_to)
+  def all_file_paths(type)
+    Dir.glob("./templates/#{type}/**/*").reject { |x| File.directory?(x) }
   end
 
-  def ask_with_default_boolean(option)
-    return @options[option] unless @options[option].nil?
-
-    result = ask(@config[:questions][option])
-    default = @config[:defaults][option] if default.nil?
-    return default if result == ''
-
-    %w[yes y true].include?(result) ? true : false
+  def template_folder
+    @options[:template_folder] || "#{File.dirname(__FILE__)}/../templates/#{@template_type}"
   end
 
   def append_or_create(file_path, file_content)

data/lib/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DockerizeStack
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/templates/rails/Dockerfile.erb

@@ -1,30 +1,30 @@
 # ****************************
 # ******Build base stage******
 # ****************************
-<% if javascrit_package_manager != "asset_pipeline" %>
-FROM node:<%= nodejs_version %>-slim as nodejs
+<% if @javascrit_package_manager != "asset_pipeline" %>
+FROM node:<%= @nodejs_version %>-slim as nodejs
 <% end %>
-FROM ruby:<%= ruby_version %>-slim as builder
+FROM ruby:<%= @ruby_version %>-slim as builder
 
 # Install common libs
 RUN apt-get update -qq && apt-get install -y \
   build-essential vim git
-<% if database == "mysql" %>
+<% if @database == "mysql" %>
 # Install Mysql
 RUN apt-get install -y mysql-client libmysqlclient-dev
-<% elsif database == "postgresql" %>
+<% elsif @database == "postgresql" %>
 # Install Postgresql
 RUN apt-get install -y postgresql-client libpq-dev
 <% end %>
-# Install Nodejs<% if javascrit_package_manager == "asset_pipeline" %>
+# Install Nodejs<% if @javascrit_package_manager == "asset_pipeline" %>
 RUN apt-get install -y nodejs npm
-<% elsif javascrit_package_manager == "yarn" %>
-ENV NODE_VERSION=<%= nodejs_version %> YARN_VERSION=<%= yarn_version %>
+<% elsif @javascrit_package_manager == "yarn" %>
+ENV NODE_VERSION=<%= @nodejs_version %> YARN_VERSION=<%= @yarn_version %>
 COPY --from=nodejs /usr/local/bin/ /usr/local/bin/
 COPY --from=nodejs /usr/local/lib/ /usr/local/lib/
-COPY --from=nodejs /opt/yarn-v<%= yarn_version %>/ /opt/yarn-v<%= yarn_version %>/
-<% elsif javascrit_package_manager == "npm" %>
-ENV NODE_VERSION=<%= nodejs_version %>
+COPY --from=nodejs /opt/yarn-v<%= @yarn_version %>/ /opt/yarn-v<%= @yarn_version %>/
+<% elsif @javascrit_package_manager == "npm" %>
+ENV NODE_VERSION=<%= @nodejs_version %>
 COPY --from=nodejs /usr/local/bin/ /usr/local/bin/
 COPY --from=nodejs /usr/local/lib/ /usr/local/lib/
 <% end %>
@@ -46,15 +46,15 @@ ENV NODE_ENV=$NODE_ENV
 # Gems cache layer
 COPY Gemfile Gemfile.lock /app/
 RUN bundle install -j 4
-<% if javascrit_package_manager == "yarn" %>
+<% if @javascrit_package_manager == "yarn" %>
 # Node modules cache layer
 COPY package.json yarn.lock /app/
 RUN yarn install --pure-lockfile
-<% elsif javascrit_package_manager == "npm" %>
+<% elsif @javascrit_package_manager == "npm" %>
 # Node modules cache layer
 COPY package.json package-lock.json /app/
 RUN npm ci
-<% elsif javascrit_package_manager == "asset_pipeline" %>
+<% elsif @javascrit_package_manager == "asset_pipeline" %>
 <% end %>
 COPY . .
 CMD "./entrypoint.sh"
@@ -64,24 +64,25 @@ CMD "./entrypoint.sh"
 # ****************************
 
 FROM builder as production-builder
+ENV NODE_ENV=production RAILS_ENV=production
 
 # Build production assets
 RUN bundle exec rails assets:precompile
-<% if javascrit_package_manager != "asset_pipeline" %>
+<% if @javascrit_package_manager != "asset_pipeline" %>
 RUN rm -r node_modules
 <% end %>
 # **********************************
 # ******Final production Stage******
 # **********************************
 
-FROM ruby:<%= ruby_version %>-slim
+FROM ruby:<%= @ruby_version %>-slim
 
 ENV NODE_ENV=production RAILS_ENV=production RAILS_LOG_TO_STDOUT=true
 
 # Install system dependencies
-<% if javascrit_package_manager != "asset_pipeline" %>
+<% if @javascrit_package_manager != "asset_pipeline" %>
 COPY --from=nodejs /usr/local/ /usr/local/
-<% end %><% if javascrit_package_manager == "asset_pipeline" %>
+<% end %><% if @javascrit_package_manager == "asset_pipeline" %>
 RUN apt-get update -qq && apt-get install -y \
   libpq-dev \
   nodejs \

data/templates/rails/config/database-docker.yml.erb

@@ -1,6 +1,6 @@
 # Update your database.yml based in database-docker.yml
 
-<% if database == "postgresql" %>
+<% if @database == "postgresql" %>
 # Install the pg driver:
 #   gem install pg
 
@@ -14,7 +14,7 @@ default: &default
   password: <%%= ENV.fetch("DATABASE_PASSWORD") { "" } %>
   pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
 
-<% elsif database == "mysql" %>
+<% elsif @database == "mysql" %>
 # Install the MySQL driver
 #   gem install mysql2
 

data/templates/rails/entrypoint.sh.erb

@@ -1,7 +1,7 @@
 bundle check || bundle install
 rake db:create db:migrate
 rm -f tmp/pids/server.pid
-<% if javascrit_package_manager == "asset_pipeline" %>
+<% if @javascrit_package_manager == "asset_pipeline" %>
 rm -rf public/packs/* || true && bin/webpack-dev-server &
 <% end %>
 bundle exec rails server -p 3000 -b 0.0.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockerize-stack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Miguel Savignano
@@ -33,17 +33,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/console
 - bin/dockerize-stack
 - lib/config.yml
 - lib/dockerize_stack.rb
-- lib/dockerize_stack/rails.rb
-- lib/dockerize_stack/react.rb
 - lib/thor_extend.rb
 - lib/version.rb
 - templates/rails/Dockerfile.erb
 - templates/rails/config/database-docker.yml.erb
 - templates/rails/docker-compose.yml.erb
-- templates/rails/dockerignore.erb
 - templates/rails/entrypoint.sh.erb
 - templates/rails/kubernetes/scripts/deploy.sh
 - templates/rails/kubernetes/scripts/get-secrets.sh
@@ -61,7 +59,6 @@ files:
 - templates/rails/nginx/etc/nginx/conf.d/default.conf
 - templates/rails/nginx/etc/nginx/nginx.conf
 - templates/react/Dockerfile.erb
-- templates/react/dockerignore.erb
 - templates/react/nginx/conf.d/default.conf.template
 homepage: https://github.com/MiguelSavignano/dockerize-stack
 licenses:

data/lib/dockerize_stack/rails.rb

@@ -1,48 +0,0 @@
-module DockerizeStack
-  # Ask variables and render templates
-  class Rails < Thor
-    include Thor::Actions
-    include ThorActionsExtend
-
-    attr_accessor :ruby_version, :javascrit_package_manager, :nodejs_version,
-                  :yarn_version, :database, :github_private, :kubernetes, :output_folder
-
-    no_commands do
-      def template_type
-        :rails
-      end
-
-      def run(options)
-        super(options)
-        render_kubernetes_templates if @kubernetes
-      end
-
-      def fetch_template_variables
-        @output_folder             = with_default(:output_folder)
-        @nodejs_version            = with_default(:nodejs_version)
-        @yarn_version              = with_default(:yarn_version)
-
-        @ruby_version              = ask_with_default(:ruby_version)
-        @javascrit_package_manager = ask_with_options(:javascrit_package_manager)
-        @database                  = ask_with_options(:database)
-        @rails_worker              = ask_with_default_boolean(:rails_worker)
-        @github_private            = ask_with_default_boolean(:github_private)
-        @kubernetes                = ask_with_default_boolean(:kubernetes)
-      end
-
-      def render_templates
-        render_template 'Dockerfile.erb'
-        render_template 'entrypoint.sh.erb'
-        render_template 'docker-compose.yml.erb'
-        render_template 'config/database-docker.yml.erb'
-        render_template 'dockerignore.erb', '.dockerignore'
-
-        puts 'Update your database.yml based in database-docker.yml'
-      end
-
-      def render_kubernetes_templates
-        directory 'kubernetes', "#{@output_folder}/kubernetes"
-      end
-    end
-  end
-end

data/lib/dockerize_stack/react.rb

@@ -1,29 +0,0 @@
-require 'thor'
-# Ask variables and render templates
-module DockerizeStack
-  # Ask variables and render templates
-  class React < Thor
-    include Thor::Actions
-    include ThorActionsExtend
-
-    attr_accessor :nodejs_version, :output_folder
-
-    no_commands do
-      def template_type
-        :react
-      end
-
-      def fetch_template_variables
-        @output_folder = with_default(:output_folder)
-        @nodejs_version = ask_with_default(:nodejs_version)
-      end
-
-      def render_templates
-        render_template 'Dockerfile.erb'
-        render_template 'dockerignore.erb', '.dockerignore'
-
-        directory 'nginx', "#{@output_folder}/nginx"
-      end
-    end
-  end
-end

data/templates/rails/dockerignore.erb

@@ -1,20 +0,0 @@
-# Ignore all files from .gitignore
-# echo .git > .dockerignore && cat .gitignore >> .dockerignore
-
-/log/*
-/tmp/*
-
-.byebug_history
-
-volumes
-
-
-public/packs
-public/packs-test
-public/uploads
-
-node_modules
-coverage
-yarn-error.log
-.DS_Store
-.git

data/templates/react/dockerignore.erb

@@ -1,27 +0,0 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-# echo .git > .dockerignore && cat .gitignore >> .dockerignore
-
-.git
-Dockerfile
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# production
-/build
-
-# misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*