cavalerie_web 1.0.0

data/lib/cavalerie_web/managers/file_folder_manager.rb

@@ -0,0 +1,99 @@
+require 'fileutils'
+
+module CavalerieWeb
+
+  class FileFolderManager
+
+    def self.create_folder_if_not_exist path
+      unless File.directory? path
+        FileUtils.mkdir_p path
+        puts Message.warning "Folder didn't exist and was created: #{path}"
+      end
+    end
+
+    def self.create_virtualhost_file_if_not_exist site
+      virtualhost_file_sample = "#{$configs_path}/VirtualHost.sample"
+      virtualhost_file = "#{site[:path]}/VirtualHost"
+
+      unless File.exist? virtualhost_file
+        FileUtils.cp virtualhost_file_sample, virtualhost_file
+        file_content = File.read virtualhost_file
+        file_content.gsub! "_site_name_here_", site[:name]
+
+        puts Message.notice "New #{site[:name]}'s VirtualHost file created."
+      end
+    end
+
+    def self.update_sites_virtualhosts_file
+      virtualhost_file = "#{$configs_path}/sites_virtualhosts"
+      File.open(virtualhost_file, 'w') do |file|
+        SiteManager.get_all_sites.each do |site|
+          file.write File.read(site[:path] + "/VirtualHost") + "\n\n"
+        end
+      end
+
+      puts Message.notice "Apache virtualhosts updated."
+    end
+
+    def self.update_hosts_file
+      # Display warning message on Windows since we can't yet update hosts file on Windows
+      if OSHelper.is_windows?
+        puts Message.warning "Windows OS detected. Unable to auto-update hosts file. Please update manually."
+      else
+        clean_up_hosts_file
+        SiteManager.get_all_sites.each do |site|
+          ghost_command "add #{site[:name]}.dev"
+        end
+        puts Message.notice "Hosts file updated."
+      end
+    end
+
+    def self.create_local_config_file_if_not_exist site
+      local_config_file_sample = "#{$configs_path}/local-config.sample.php"
+      local_config_file = "#{site[:path]}/local-config.php"
+
+      unless File.exist? local_config_file
+        FileUtils.cp local_config_file_sample, local_config_file
+        file_content = File.read local_config_file
+        file_content.gsub! "_db_name_here_", site[:name]
+        file_content.gsub! "_db_host_here_", ENV["DB_PORT_3306_TCP_ADDR"].to_s
+
+        puts Message.notice "New #{site[:name]}'s local-config.php file created."
+      end
+    end
+
+    def self.update_local_config_files
+      SiteManager.get_all_sites.each do |site|
+        local_config_file = "#{site[:path]}/local-config.php"
+
+        if File.exist? local_config_file
+          File.delete local_config_file
+          puts Message.notice "Previous #{site[:name]}'s local-config.php file deleted."
+        end
+
+        create_local_config_file_if_not_exist site
+      end
+    end
+
+    def self.clean_up_hosts_file
+      ghost_command "bust"
+    end
+
+    def self.get_hosts_list
+      begin
+        raise UnableToAccessHostsFileOnWindowsOSError if OSHelper.is_windows?
+        ghost_command "list"
+      rescue UnableToAccessHostsFileOnWindowsOSError
+        puts Message.error "Windows OS detected. Unable to access hosts file."
+      end
+    end
+
+    private
+
+      def self.ghost_command command
+        `sudo ghost #{command}`
+      end
+
+  end
+
+end

data/lib/cavalerie_web/managers/sequence_manager.rb

@@ -0,0 +1,97 @@
+module CavalerieWeb
+
+  class SequenceManager
+
+    def self.start_sequence sequence_name, max_retries=1
+      Dir.chdir $gem_path
+
+      klass = Object.const_get(format_to_sequence_class(sequence_name))
+      human_sequence_name = format_for_human sequence_name
+      retry_counter = 0
+      sequence_ended = false
+
+      while !sequence_ended
+        begin
+          Dir.chdir $gem_path
+
+          if retry_counter == 0
+            puts Message.notice "Starting sequence \"#{human_sequence_name}\""
+          else
+            puts Message.notice "Restarting sequence \"#{human_sequence_name}\" (try: #{retry_counter + 1})"
+          end
+
+          klass.start
+
+          sequence_ended = true
+
+        rescue StandardError => error
+          begin
+
+            puts Message.warning "Error #{error.class}: #{error.message}\n\nCurrent path: #{Dir.pwd}\n\nBacktrace:\n\n" + error.backtrace.join("\n") + "\n\n"
+
+            retry_counter += 1
+            raise MaxRetriesReachError, "Sequence \"#{human_sequence_name}\" restarted #{max_retries} time(s) but never completed successfully" unless retry_counter < max_retries
+
+            puts Message.notice "Rescuing #{error.class} from sequence #{klass.to_s}"
+
+            klass.rescue error
+            next
+
+          rescue StandardError => error
+            Config.reset_setup_status
+            sequence_ended = true
+            abort Message.error "Failed to rescue: #{error.message}\n\nBacktrace:\n\n" + error.backtrace.join("\n")
+          end
+
+        end
+      end
+    end
+
+    def self.set_threads_timeout threads_array, timeout = 15
+      time = 0
+
+      while threads_array.count > 0
+
+        if time < timeout
+          sleep 1
+          time += 1
+          time_left = timeout - time
+
+          if time === 3
+            puts Message.warning "It's seems to take longer than usual..."
+          end
+
+          if time > 4 && time_left > 0
+            puts Message.warning "#{timeout - time} second(s) left before timeout"
+          end
+
+          threads_array.delete_if do |thread|
+            thread.status == false
+          end
+
+        else
+          puts Message.error "Timout. #{threads_array.count} thread(s) not finished in time.\n\nThreads: #{threads_array}"
+
+          threads_array.each do |thread|
+            thread.kill
+          end
+          threads_array.clear
+
+          abort
+        end
+      end
+    end
+
+    private
+
+      def self.format_to_sequence_class sequence_name
+        "CavalerieWeb::" + sequence_name.to_s.downcase.split(/[_\ ]/).map { |word| word.capitalize }.join + "Sequence"
+      end
+
+      def self.format_for_human sequence_name
+        sequence_name.to_s.gsub('_', ' ').capitalize
+      end
+
+  end
+
+end

data/lib/cavalerie_web/managers/site_manager.rb

@@ -0,0 +1,37 @@
+module CavalerieWeb
+
+  class SiteManager
+
+    def self.get_all_sites
+      sites = []
+
+      site_paths = Dir.glob("#{get_sites_folder_path}/*").select { |f| File.directory? f }
+      site_paths.each do |path|
+        sites << { name: path.split("/").last, path: path }
+      end
+
+      sites
+    end
+
+    def self.ensure_sites_are_valid
+      sites = get_all_sites
+      puts Message.warning "#{sites.count} site(s) found in sites folder"
+
+      sites.each do |site|
+        FileFolderManager.create_folder_if_not_exist "#{site[:path]}/logs"
+        FileFolderManager.create_folder_if_not_exist "#{$shared_folder_path}/#{site[:name]}"
+        FileFolderManager.create_virtualhost_file_if_not_exist site
+        FileFolderManager.create_local_config_file_if_not_exist site
+
+        puts Message.success "Site \"#{site[:name]}\" is valid"
+      end
+    end
+
+    private
+      def self.get_sites_folder_path
+        $sites_folder_path
+      end
+
+  end
+
+end

data/lib/cavalerie_web/managers/vagrant_manager.rb

@@ -0,0 +1,66 @@
+module CavalerieWeb
+
+  class VagrantManager
+
+    def self.get_container_status container_name
+      status = VagrantHelper.status(container_name)
+
+      begin
+        case status
+        when /not created \(docker\)/
+          "not created"
+        when /running \(docker\)/
+          "running"
+        when /saved \(docker\)/
+          "saved"
+        when /preparing \(docker\)/
+          "preparing"
+        when /poweroff \(docker\)/
+          "poweroff"
+        when /stopped \(docker\)/
+          "stopped"
+        when /host state unknown \(docker\)/
+          "host state unknown"
+        else
+          raise UnknownDockerContainerStatusError, status
+        end
+      rescue UnknownDockerContainerStatusError => error
+        abort Message.error "The container #{container_name} is in an unknown state.\n\nVagrant status command output:\n\n#{error.message}"
+      end
+
+    end
+
+    def self.ensure_containers_are_running
+      begin
+        Config.get_containers_names.each do |container_name|
+          raise ContainerNotRunningError, container_name unless get_container_status(container_name) == "running"
+        end
+      rescue ContainerNotRunningError => error
+        abort Message.error "Container \"#{error.message}\" isn't running. Are you sure you have already run the command \"cavalerie up\"?\n\nIf the problem persists, this often means there is already another Vagrant virtual machine running in VirtualBox.\nPlease find and delete any virtual machine named \"Vagrant-Dockerhost\" in VirtualBox, and run \"cavalerie up\" again."
+      end
+    end
+
+    def self.start_or_restart_containers
+      destroy_containers
+      start_containers
+    end
+
+    def self.start_containers
+      Config.get_containers_names.each do |container_name|
+        VagrantHelper.start_container container_name
+
+        if Config.get_docker_configs["#{container_name}_post_start_script"]
+          VagrantHelper.run_script container_name, "/scripts/post_start.rb"
+        end
+      end
+    end
+
+    def self.destroy_containers
+      Config.get_containers_names.each do |container_name|
+        VagrantHelper.destroy_container container_name unless get_container_status(container_name) == "not created"
+      end
+    end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/base_sequence.rb

@@ -0,0 +1,9 @@
+class CavalerieWeb::BaseSequence
+
+  def self.start
+  end
+
+  def self.rescue
+  end
+
+end

data/lib/cavalerie_web/sequences/cavalerie_destroy_sequence.rb

@@ -0,0 +1,12 @@
+module CavalerieWeb
+
+  class CavalerieDestroySequence < BaseSequence
+
+    def self.start
+      SequenceManager.start_sequence :ensure_setup_is_correct, 2
+      VagrantManager.destroy_containers
+    end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/cavalerie_init_sequence.rb

@@ -0,0 +1,71 @@
+module CavalerieWeb
+
+  class CavalerieInitSequence < BaseSequence
+
+    def self.start
+      welcome_message
+
+      variables_to_export = []
+
+      Config.get_environment_variables.each_with_index do |environment_variable, index|
+
+        name = environment_variable[1][:name]
+        folder = environment_variable[1][:folder]
+        description = environment_variable[1][:description]
+        default_folder_path = "#{ENV['HOME']}/cavalerie/#{folder}"
+
+        puts "\n#{index + 1}. Which location for \"#{folder.colorize(:yellow)}\" folder? (default: #{default_folder_path})"
+        puts description
+        print "\n#{name}: "
+        path = $stdin.gets.chomp
+        puts "\n"
+
+        if path.empty?
+          variables_to_export << "export #{name}=#{default_folder_path}"
+          FileFolderManager.create_folder_if_not_exist default_folder_path
+        else
+          path.gsub!('~', ENV['HOME'])
+          variables_to_export << "export #{name}=#{path}"
+          FileFolderManager.create_folder_if_not_exist path
+        end
+
+      end
+
+      add_environment_variables_instructions variables_to_export
+
+      puts "\n"
+    end
+
+    private
+
+      def self.welcome_message
+        puts <<-EOF
+
+Hello, and if it's your first run, welcome!
+
+This gem is designed to help you improve your productivity when developping with Wordpress.
+Your new development environment will be composed of:
+
+  √ Vagrant Linux virtual machine
+  √ Apache Docker container for your webserver
+  √ MySQL server Docker container for your database
+
+Everything is almost done automatically, so you don't have to worry about configuration.
+
+Let's begin:
+
+        EOF
+      end
+
+      def self.add_environment_variables_instructions variables_to_export_array
+        puts "ONE MORE STEP!".colorize(:green)
+        puts "\nTo complete the setup, please add the following variables to your shell profile\n(for example: ~/.bashrc for bash, ~/.zshrc for ZSH)\n\n"
+
+        variables_to_export_array.each do |variables_to_export|
+          puts "\t#{variables_to_export}".colorize(:yellow)
+        end
+      end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/cavalerie_refresh_sequence.rb

@@ -0,0 +1,21 @@
+module CavalerieWeb
+
+  class CavalerieRefreshSequence < BaseSequence
+
+    def self.start
+      SequenceManager.start_sequence :ensure_setup_is_correct, 2
+      VagrantManager.ensure_containers_are_running
+
+      # ------ Shared part with Cavalerie up sequence ------- #
+      # TODO: factorize that
+      SiteManager.ensure_sites_are_valid
+      FileFolderManager.update_sites_virtualhosts_file
+      FileFolderManager.update_hosts_file
+      FileFolderManager.update_local_config_files
+      DatabaseManager.create_sites_database_if_not_exist
+      # ------ Shared part with Cavalerie up sequence ------- #
+    end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/cavalerie_status_sequence.rb

@@ -0,0 +1,107 @@
+module CavalerieWeb
+
+  class CavalerieStatusSequence < BaseSequence
+
+    def self.start
+
+      SequenceManager.start_sequence :ensure_setup_is_correct, 2
+
+      docker_configs = Config.get_docker_configs
+
+      apache_status = colorize_status VagrantManager.get_container_status docker_configs["apache-server_container_name"]
+      mysql_status = colorize_status VagrantManager.get_container_status docker_configs["mysql-server_container_name"]
+
+      virtualhosts_content = get_virtualhosts_content
+
+      hosts_file_content = FileFolderManager.get_hosts_list
+
+      site_list_array = get_site_list hosts_file_content, virtualhosts_content
+      site_list = ""
+
+      site_list_array.each_with_index do |site, index|
+        site_list += "\t#{index + 1}. #{site[:name].colorize(:light_blue)}\n"
+        site_list += "\t\t\t- URL: #{site[:url]}\n"
+        site_list += "\t\t\t- Is in virtualhost? #{site[:virtualhost]}\n\n"
+      end
+
+      print <<-EOF
+
+ ------------------------------------------------------------------------------------------------------------------
+| \t#{"SYSTEM STATUS SUMMARY".colorize(:yellow)}                                                                                      |
+------------------------------------------------------------------------------------------------------------------
+
+ \tApache server
+ \t\t\t - Container status    #{apache_status}
+ \t\t\t - Container name      #{docker_configs["containers_names"][1]}
+ \t\t\t - Container IP        #{docker_configs["apache-server_container_ip"]}
+ \t\t\t - Machine OS          #{docker_configs["apache-server_os"]}
+ \t\t\t - Apache version      #{docker_configs["apache-server_version"]}
+
+ \tMySQL server
+ \t\t\t - Container status    #{mysql_status}
+ \t\t\t - Container name      #{docker_configs["containers_names"][0]}
+ \t\t\t - Container IP        #{docker_configs["mysql-server_container_ip"]}
+ \t\t\t - Machine OS          #{docker_configs["mysql-server_os"]}
+ \t\t\t - MySQL version       #{docker_configs["mysql-server_version"]}
+ \t\t\t - MySQL user / pass   #{docker_configs["mysql-server_user"]} / #{docker_configs["mysql-server_user_password"]}
+ \t\t\t - MySQL root pass     #{docker_configs["mysql-server_root_password"]}
+
+ \tFolders paths
+ \t\t\t - Sites               #{$sites_folder_path}
+ \t\t\t - Shared              #{$shared_folder_path}
+ \t\t\t - MySQL               #{$mysql_folder_path}
+ \t\t\t - Export              #{$export_folder_path}
+
+ \tSites in sites folder
+
+#{site_list}
+ ------------------------------------------------------------------------------------------------------------------
+| \t#{"MORE DETAILS".colorize(:yellow)}                                                                                               |
+ ------------------------------------------------------------------------------------------------------------------
+
+  Apache virtualhosts file content
+
+#{virtualhosts_content}
+
+ ------------------------------------------------------------------------------------------------------------------
+
+      EOF
+    end
+
+    private
+
+      def self.colorize_status status
+        case status
+        when "running"
+          status.colorize(:green)
+        when "not created"
+          status.colorize(:red)
+        else
+          status.colorize(:yellow)
+        end
+      end
+
+      def self.get_virtualhosts_content
+        virtualhost_file = "#{$configs_path}/sites_virtualhosts"
+        if File.exist? virtualhost_file
+          "\n#{File.read(virtualhost_file)}"
+        else
+          Message.warning "Apache virtualhosts file doesn't exist yet.\nDon't worry too much: it will be automatically\ncreated when you'll run 'cavalerie up'"
+        end
+      end
+
+      def self.get_site_list hosts_file_content, virtualhosts_content
+        site_list = []
+
+        SiteManager.get_all_sites.each_with_index do |site, index|
+          site_url = hosts_file_content.include?(site[:name]) ? "http://#{site[:name]}.dev".colorize(:green) : "Not found in Hosts file".colorize(:red)
+          site_in_virtualhost = virtualhosts_content.include?(site[:name]) ? "Yes".colorize(:green) : "No".colorize(:red)
+
+          site_list << { name: site[:name], url: site_url, virtualhost: site_in_virtualhost }
+        end
+        site_list
+      end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/cavalerie_up_sequence.rb

@@ -0,0 +1,24 @@
+module CavalerieWeb
+
+  class CavalerieUpSequence < BaseSequence
+
+    def self.start
+      SequenceManager.start_sequence :ensure_setup_is_correct, 2
+
+      # ------ Shared part with Cavalerie refresh sequence ------- #
+      # TODO: factorize that
+      SiteManager.ensure_sites_are_valid
+      FileFolderManager.update_sites_virtualhosts_file
+      FileFolderManager.update_hosts_file
+      FileFolderManager.update_local_config_files
+      # ------ Shared part with Cavalerie refresh sequence ------- #
+
+      VagrantManager.start_or_restart_containers
+      VagrantManager.ensure_containers_are_running
+
+      DatabaseManager.create_sites_database_if_not_exist
+    end
+
+  end
+
+end

data/lib/cavalerie_web/sequences/ensure_setup_is_correct_sequence.rb

@@ -0,0 +1,77 @@
+module CavalerieWeb
+
+  class EnsureSetupIsCorrectSequence < BaseSequence
+
+    def self.start
+      threads = []
+
+      setup_status = Config.get_setup_status
+
+      if setup_status["is_vagrant_installed?"] != true
+        threads << Thread.new { ensure_vagrant_is_installed }
+      end
+
+      if setup_status["are_required_plugins_installed?"] != true
+        threads << Thread.new { ensure_required_plugins_are_installed }
+      end
+
+      threads << Thread.new { ensure_environment_variables_are_set }
+      threads << Thread.new { ensure_required_folders_are_available }
+
+      SequenceManager.set_threads_timeout threads
+    end
+
+    def self.rescue error
+      case error.class.to_s
+
+      when "RequiredPluginMissingError"
+        missing_plugins = eval(error.message)
+        missing_plugins.each do |plugin_name|
+          puts Message.warning "Plugin \"#{plugin_name.capitalize}\" is not installed. Installing..."
+          VagrantHelper.plugin_install plugin_name
+        end
+      when "RequiredFolderUnavailableError"
+        missing_folders_paths = eval(error.message)
+        puts Message.warning error_message = "#{missing_folders_paths.count} required folder(s) are missing"
+        missing_folders_paths.each { |folder_path| FileFolderManager.create_folder_if_not_exist folder_path }
+      else
+        raise error
+      end
+    end
+
+    private
+
+      def self.ensure_vagrant_is_installed
+        begin
+          raise VagrantNotInstalledError unless VagrantCheck.is_vagrant_installed?
+        rescue VagrantNotInstalledError
+          abort Message.error "Vagrant isn't installed. Please visit https://www.vagrantup.com for installation details."
+        end
+      end
+
+      def self.ensure_required_plugins_are_installed
+        if missing_plugins = VagrantCheck.is_a_required_plugin_missing?
+          raise RequiredPluginMissingError, missing_plugins
+        end
+      end
+
+      def self.ensure_environment_variables_are_set
+        unset_environment_variables = []
+        Config.get_environment_variables.each do |environment_variable|
+          unset_environment_variables << environment_variable[1][:name] unless ENV[environment_variable[1][:name]]
+        end
+
+        if unset_environment_variables.count > 0
+          abort Message.error "#{unset_environment_variables.count} environment variable(s) are unset. Please run \"cavalerie init\" to resolve this problem."
+        end
+      end
+
+      def self.ensure_required_folders_are_available
+        if missing_folders_paths = FileFolderCheck.is_a_required_folder_unavailable?
+          raise RequiredFolderUnavailableError, missing_folders_paths
+        end
+      end
+
+  end
+
+end

data/lib/cavalerie_web/ui/banner.rb

@@ -0,0 +1,16 @@
+class CavalerieWeb::Banner
+
+  def self.cavalerie
+
+    banner = <<-EOF
+
+ _      _      ___   ___   ___   _    ___ ___ ___ ___
+| |    /_\\    / __| /_\\ \\ / /_\\ | |  | __| _ \\_ _| __|
+| |__ / _ \\  | (__ / _ \\ V / _ \\| |__| _||   /| || _|
+|____/_/ \\_\\  \\___/_/ \\_\\_/_/ \\_\\____|___|_|_\\___|___|
+    EOF
+
+    puts banner.colorize(:light_blue)
+  end
+
+end

data/lib/cavalerie_web/ui/message.rb

@@ -0,0 +1,23 @@
+module CavalerieWeb
+
+  class Message
+
+    def self.success message
+      "[ √ ] #{message}".colorize(:green)
+    end
+
+    def self.error message
+      "[ X ] #{message}".colorize(:red)
+    end
+
+    def self.warning message
+      "[ ! ] #{message}".colorize(:yellow)
+    end
+
+    def self.notice message
+      "#{'[ - ]'.colorize(:cyan)} #{message}"
+    end
+
+  end
+
+end