dockerize_rails 1.0.3.beta.1

data/lib/dockerize_rails/constants.rb

@@ -0,0 +1,48 @@
+module DockerizeRails
+  module Constants
+    SHELL_SCRIPT_FILE_NAME = 'dockerw'.freeze
+
+    DOCKERIZE_RAILS_CONFIG_FILE_NAME = '.dockerize.yml'.freeze
+    DOCKER_COMPOSE_FILE_NAME = 'docker-compose.yml'.freeze
+    DOCKERIGNORE_FILE_NAME = '.dockerignore'.freeze
+
+    RAILS_DIRECTORY_NAME = 'rails'.freeze
+    MYSQL_DIRECTORY_NAME = 'mysql'.freeze
+    PG_DIRECTORY_NAME = 'postgresql'.freeze
+    CONFIG_DIRECTORY_NAME = '.dockerized'.freeze
+    DATA_DIRECTORY_NAME = 'data_dir'.freeze
+    SQL_DIRECTORY_NAME = 'sql'.freeze
+
+    DATABASE_HOST_LINKED = 'linked'.freeze
+    DATABASE_HOST_REMOTE = 'remote'.freeze
+
+    COMMANDS = {
+      configure: {
+        aliases: %I[configure c rc cr],
+        help: "Generates '#{DOCKERIZE_RAILS_CONFIG_FILE_NAME}'".freeze,
+        params: {
+          :'--skip-desc' => 'generates shorter config file, skipping all descriptions'.freeze
+        }
+      },
+      dockerize: {
+        aliases: %I[dockerize dc d],
+        help: 'Generates docker config files'.freeze
+      },
+      docker_info: {
+        aliases: %I[docker_info di],
+        help: 'Shows Docker information'.freeze
+      },
+      undockerize: {
+        aliases: %I[undockerize ud du u dd],
+        help: 'Removes docker configurations'.freeze,
+        params: {
+          :'--purge' => "also removes #{Constants::DOCKERIZE_RAILS_CONFIG_FILE_NAME}".freeze
+        }
+      },
+      help: {
+        aliases: %I[help h],
+        help: 'prints this message'.freeze
+      }
+    }.freeze
+  end
+end

data/lib/dockerize_rails/docker_helper.rb

@@ -0,0 +1,9 @@
+module DockerizeRails
+  module DockerHelper
+    require 'docker'
+
+    def self.version
+      Docker.version
+    end
+  end
+end

data/lib/dockerize_rails/dr_config.rb

@@ -0,0 +1,149 @@
+module DockerizeRails
+  class DRConfig
+    ATTRIBUTES = %i[
+      application_name ruby_version application_env application_port postgres_version mysql_version
+      database_host_type database_host_name mysql_root_pass database_user_name database_user_pass
+      databases
+    ].freeze
+
+    @application_name     = File.basename PATHS.current
+
+    @ruby_version         = 'latest'
+    @application_env      = 'development'
+    @application_port     = '5000'
+
+    @postgres_version     = 'alpine'
+    @mysql_version        = 'latest'
+
+    @database_host_type   = Constants::DATABASE_HOST_LINKED
+    @database_host_name   = 'databasehost'
+    @database_user_name   = 'user'
+    @database_user_pass   = 'pass'
+
+    @mysql_root_pass      = 'root'
+
+    @databases            = {}
+
+    def self.load_dockerize_rails_config
+      dockerize_rails_config_file = File.join(PATHS.current, Constants::DOCKERIZE_RAILS_CONFIG_FILE_NAME)
+      if File.exist? dockerize_rails_config_file
+        dockerize_rails_config = YAML.load_file(dockerize_rails_config_file)
+        ATTRIBUTES.each do |attr|
+          attr_conf = dockerize_rails_config[attr.to_s]
+          send("#{attr}=", attr_conf) unless attr_conf.to_s.empty?
+        end
+      else
+        puts "\nDockerizeRails config file not generated...".yellow
+        puts "Run 'bundle exec dock configure' to generate configuration file.\n".yellow
+      end
+    end
+
+    def self.remote_database?
+      database_host_type == Constants::DATABASE_HOST_REMOTE
+    end
+
+    def self.linked_database?
+      database_host_type == Constants::DATABASE_HOST_LINKED
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def self.to_yaml_str
+      "---
+# Set application name
+#
+# Default is Rails Application Directory Name
+application_name: #{application_name}
+
+# Set docker container's rails environment to production, staging, or development
+# Make sure application is properly configured to run in 'application_env' (#{application_env})
+#
+# Default is #{application_env}
+application_env: #{application_env}
+
+# Set docker container's rails port to access from local machine
+# Make sure it doesn't conflict with any of the ports active in host machine
+#
+# Default #{application_port}
+application_port: #{application_port}
+
+# Set ruby version
+# Visit: https://hub.docker.com/_/ruby/ for list of available versions
+#
+# Default is #{ruby_version}
+ruby_version: #{ruby_version}
+
+# Set database host type
+#
+# Available values are '#{Constants::DATABASE_HOST_LINKED}', '#{Constants::DATABASE_HOST_REMOTE}'
+# Default #{database_host_type}
+database_host_type: #{database_host_type}
+
+# Hostname to connect to database
+# Ignored if 'database_host_type' is '#{Constants::DATABASE_HOST_LINKED}'
+database_host_name: #{database_host_name}
+
+# Set root password for docker database container
+# it doesn't make any changes in your computer's database
+# It will be used only for MySQL database
+#
+# Default #{mysql_root_pass}
+mysql_root_pass: #{mysql_root_pass}
+
+# Set postgres database version if application uses postgres
+# Visit: https://hub.docker.com/_/postgres/ for list of available versions
+#
+# Default is #{postgres_version}
+postgres_version: #{postgres_version}
+
+# Set mysql database version if application uses mysql
+# Visit: https://hub.docker.com/_/mysql/ for list of available versions
+#
+# Default is #{mysql_version}
+mysql_version: #{mysql_version}
+
+# Set database properties
+
+# Default database username for container's internal use
+# It has no impact on host machine's database
+# Default #{database_user_name}
+database_user_name: #{database_user_name}
+
+# Default database password for container's internal use
+# It has no impact on host machine's database
+# Default #{database_user_pass}
+database_user_pass: #{database_user_pass}
+"
+    end
+
+    def self.to_yaml
+      "---
+application_name: #{application_name}
+application_env: #{application_env}
+application_port: #{application_port}
+ruby_version: #{ruby_version}
+database_host_type: #{database_host_type}
+database_host_name: #{database_host_name}
+mysql_root_pass: #{mysql_root_pass}
+postgres_version: #{postgres_version}
+mysql_version: #{mysql_version}
+database_user_name: #{database_user_name}
+database_user_pass: #{database_user_pass}
+"
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def self.to_hash
+      Hash[ATTRIBUTES.map do |accessor|
+        [accessor, send(accessor.to_s)]
+      end]
+    end
+
+    class << self
+      attr_accessor(*ATTRIBUTES)
+      def database_host_name
+        return 'databasehost' if database_host_type == Constants::DATABASE_HOST_LINKED
+        @database_host_name
+      end
+    end
+  end
+end

data/lib/dockerize_rails/dr_name_space.rb

@@ -0,0 +1,54 @@
+module DockerizeRails
+  class DRNameSpace
+    require 'ostruct'
+
+    @namespace = OpenStruct.new
+
+    attr_reader :namespace
+
+    def self.load
+      DRConfig.load_dockerize_rails_config
+      load_from_app_config
+      load_from_dockerize_rails_config
+    end
+
+    def self.load_from_app_config
+      app_c = ConfigLoader.app_config
+      databases = {}
+      app_c.keys.each do |env|
+        adapter = app_c[env]['adapter']
+        databases[env] =
+          if adapter.start_with?('mysql')
+            'mysql'
+          elsif adapter.start_with?('postgresql')
+            'postgresql'
+          elsif adapter.start_with?('sqlite')
+            'sqlite'
+          end
+      end
+      @namespace.databases = databases
+      DRConfig.databases = databases
+    end
+
+    def self.load_from_dockerize_rails_config
+      DRConfig.to_hash.map do |key, value|
+        @namespace.send("#{key}=", value)
+      end
+    end
+
+    def self.add_hash(hash)
+      hash.map do |key, value|
+        @namespace.send("#{attr}=", rc[key] || value)
+      end
+    end
+
+    def self.eval_i
+      @namespace.instance_eval { binding }
+    end
+
+    class << self
+      private :load_from_app_config
+      private :load_from_dockerize_rails_config
+    end
+  end
+end

data/lib/dockerize_rails/helpers.rb

@@ -0,0 +1,62 @@
+module DockerizeRails
+  module Helpers
+    require 'ostruct'
+
+    def self.processed_commands
+      Hash[Constants::COMMANDS.keys.map do |key|
+        [key, Constants::COMMANDS[key][:aliases].map(&:to_s)]
+      end]
+    end
+
+    def self.parse_opts
+      [ARGV[0].to_s, args: ARGV[1..ARGV.size].to_a]
+    end
+
+    def self.ensure_rails_root
+      unless PATHS.rails_root?
+        puts "\n'#{`pwd`.strip}' is not a rails application root.\n".red
+        exit(1)
+      end
+      0
+    end
+
+    def self.params_help(command)
+      if command.key? :params
+        [command[:params].keys.map do |param|
+          "\n          #{('[' + param.to_s + ']').ljust(15, ' ')} -- #{command[:params][param]}"
+        end,
+         "\n"].join
+      else
+        ''
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def self.help
+      ['
+Usage: rocker <command>
+   or: bundle exec dock <command>
+
+   commands:
+       ',
+       Constants::COMMANDS.keys.map do |key|
+         command = Constants::COMMANDS[key]
+         "        #{command[:aliases].map(&:to_s).join(', ').ljust(30, ' ')}" \
+           " - #{command[:help]}" + params_help(command)
+       end,
+       '
+       '].join("\n")
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength
+
+    def self.print_formatted_info(name, value)
+      print name.ljust(15, ' ').yellow, value.blue
+    end
+
+    class << self
+      private :params_help
+    end
+  end
+end

data/lib/dockerize_rails/paths.rb

@@ -0,0 +1,51 @@
+module DockerizeRails
+  module PATHS
+    def self.gem_root
+      File.expand_path '../..', File.dirname(__FILE__)
+    end
+
+    def self.current
+      Dir.pwd
+    end
+
+    def self.rails_root?
+      File.exist? File.join(current, 'bin', 'rails')
+    end
+
+    def self.resources(name = '')
+      File.join(gem_root, 'resources', name)
+    end
+
+    def self.config_directory
+      File.join(current, Constants::CONFIG_DIRECTORY_NAME)
+    end
+
+    def self.rails_directory
+      File.join(config_directory, Constants::RAILS_DIRECTORY_NAME)
+    end
+
+    def self.mysql_directory
+      File.join(config_directory, Constants::MYSQL_DIRECTORY_NAME)
+    end
+
+    def self.postgresql_directory
+      File.join(config_directory, Constants::PG_DIRECTORY_NAME)
+    end
+
+    def self.data_directory(db_dir_name)
+      File.join(config_directory, db_dir_name, Constants::DATA_DIRECTORY_NAME)
+    end
+
+    def self.sql_directory(db_dir_name)
+      File.join(config_directory, db_dir_name, Constants::SQL_DIRECTORY_NAME)
+    end
+
+    def self.relative(base, target)
+      Pathname.new(target).relative_path_from(Pathname.new(base)).to_s
+    end
+
+    def self.relative_from_current(target)
+      relative(current, target)
+    end
+  end
+end

data/lib/dockerize_rails/templates.rb

@@ -0,0 +1,27 @@
+module DockerizeRails
+  module Templates
+    ROOT_TEMPLATES = %W[
+      #{Constants::DOCKERIGNORE_FILE_NAME}
+      #{Constants::DOCKER_COMPOSE_FILE_NAME}
+      #{Constants::SHELL_SCRIPT_FILE_NAME}
+    ].freeze
+
+    RAILS_TEMPLATES = %w[Dockerfile entry-point.sh secrets.yml].freeze
+    MYSQL_TEMPLATES = %W[Dockerfile #{Constants::SQL_DIRECTORY_NAME}/initdb-mysql.sql].freeze
+    POSTGRES_TEMPLATES = %w[Dockerfile].freeze
+
+    ROOT_DIRECTORIES = %W[#{Constants::CONFIG_DIRECTORY_NAME}].freeze
+    RAILS_DIRECTORIES = %W[#{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::RAILS_DIRECTORY_NAME}].freeze
+    MYSQL_DIRECTORIES = %W[
+      #{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::MYSQL_DIRECTORY_NAME}
+      #{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::MYSQL_DIRECTORY_NAME}/#{Constants::SQL_DIRECTORY_NAME}
+      #{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::MYSQL_DIRECTORY_NAME}/#{Constants::DATA_DIRECTORY_NAME}
+    ].freeze
+    PG_DIRECTORIES = %W[
+      #{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::PG_DIRECTORY_NAME}
+      #{Constants::CONFIG_DIRECTORY_NAME}/#{Constants::PG_DIRECTORY_NAME}/#{Constants::DATA_DIRECTORY_NAME}
+    ].freeze
+
+    EXECUTABLES = %W[#{Constants::SHELL_SCRIPT_FILE_NAME}].freeze
+  end
+end

data/lib/dockerize_rails/version.rb

@@ -0,0 +1,3 @@
+module DockerizeRails
+  VERSION = '1.0.3.beta.1'.freeze
+end

data/lib/dockerize_rails.rb

@@ -0,0 +1,29 @@
+require 'dockerize_rails/version'
+require 'dockerize_rails/constants'
+require 'dockerize_rails/templates'
+require 'dockerize_rails/paths'
+require 'dockerize_rails/helpers'
+require 'dockerize_rails/dr_config'
+require 'dockerize_rails/config_loader'
+require 'dockerize_rails/dr_name_space'
+require 'dockerize_rails/config_generator'
+require 'dockerize_rails/docker_helper'
+require 'dockerize_rails/command_line_methods'
+require 'dockerize_rails/command_line'
+
+module DockerizeRails
+  private_constant :PATHS
+  private_constant :Helpers
+  private_constant :DRNameSpace
+  private_constant :ConfigLoader
+  private_constant :DRConfig
+  private_constant :ConfigGenerator
+  private_constant :DockerHelper
+  private_constant :Constants
+  private_constant :Templates
+  private_constant :CommandLineMethods
+end
+
+class DockerizeRailsCLI
+  extend DockerizeRails::CommandLine
+end

data/resources/.dockerignore.erb

@@ -0,0 +1,25 @@
+.idea/*
+.bundle
+test
+vendor/bundle
+vendor/ruby
+log/*
+tmp/*
+!/log/.keep
+!/tmp/.keep
+.byebug_history
+config/database.yml
+.ruby-gemset
+.ruby-version
+public/uploads
+public/assets
+
+<%= Constants::DOCKERIZE_RAILS_CONFIG_FILE_NAME %>
+<%= Constants::DOCKER_COMPOSE_FILE_NAME %>
+<%= Constants::DOCKERIGNORE_FILE_NAME %>
+<%= Constants::SHELL_SCRIPT_FILE_NAME %>
+<% if DRConfig.linked_database? %>
+<% if databases.values.include?('mysql') || databases.values.include?('postgresql') %>
+<%= "#{Constants::CONFIG_DIRECTORY_NAME}/#{databases[application_env]}/#{Constants::DATA_DIRECTORY_NAME}/*" %>
+<% end %>
+<% end %>

data/resources/docker-compose.yml.erb

@@ -0,0 +1,47 @@
+version: '3'
+
+services:
+  rails:
+    build:
+      context: .
+      dockerfile: ./<%= "#{Constants::CONFIG_DIRECTORY_NAME}/rails/Dockerfile" %>
+    expose:
+      - '<%= application_port %>'
+    ports:
+      - '<%= "#{application_port}:#{application_port}" %>'
+<% if DRConfig.linked_database? %>
+<% if databases.values.include?('mysql') || databases.values.include?('postgresql') %>
+    links:
+      - '<%= databases[application_env] %>:<%= database_host_name %>'
+    depends_on:
+      - <%= databases[application_env] %>
+<% end %>
+<% end %>
+
+<% if DRConfig.linked_database? %>
+<% if databases.values.include?('mysql') || databases.values.include?('postgresql') %>
+  <%= databases[application_env] %>:
+    build:
+      context: .
+      dockerfile: ./<%= "#{Constants::CONFIG_DIRECTORY_NAME}/#{databases[application_env]}/Dockerfile" %>
+    volumes:
+      - './<%= "#{Constants::CONFIG_DIRECTORY_NAME}/#{databases[application_env]}/#{Constants::DATA_DIRECTORY_NAME}" %>:/var/lib/<%= databases[application_env] %>:rw'
+    ports:
+      <% if databases[application_env] == 'postgresql' %>
+      - '5400:5432'
+      <% elsif databases[application_env] == 'mysql' %>
+      - '3300:3306'
+      <% end %>
+    environment:
+      <% if databases[application_env] == 'postgresql' %>
+      - POSTGRES_USER=<%= database_user_name %>
+      - POSTGRES_PASSWORD=<%= database_user_pass %>
+      <% elsif databases[application_env] == 'mysql' %>
+      - MYSQL_ROOT_PASSWORD=<%= mysql_root_pass %>
+        <% if database_user_name != 'root' %>
+      - MYSQL_USER=<%= database_user_name %>
+      - MYSQL_PASSWORD=<%= database_user_pass %>
+        <% end %>
+      <% end %>
+<% end %>
+<% end %>