containers 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10eb220c07fba010dcc7f06bfbece1feef00f33f7521ea6c64422e0158d5f4b2
-  data.tar.gz: fc61199216e1aa3fe368d5a26b98b775a31cf3ac0a6723fae29c25d0fe5f9912
+  metadata.gz: cd15c1e87342149b417b3b8671d6a435badd75d2bed6c32d4ca81d5cdce6e5b8
+  data.tar.gz: 9066bc4c1a4890a9eea31c5d22d92ed812090ebdb3bc45dad76f130ae686ad7f
 SHA512:
-  metadata.gz: 9d597a36e082a8d692de221f41e60d07a38bb509cf08e56d47123178ee680bd46af86f8981b57aef772772a4da587976c5894da36f943127ec5b259d50cd6d07
-  data.tar.gz: 50dc68c00349412c3f74a799a0c47b054dea7cdd8d078a9c87987a3d79b2f84d42fbd6540414ccb00b5757b6bfcea09ccce1dd09b688b8769e473fbca4d1f040
+  metadata.gz: 2f6d65ae82057568913304f231b84fa46671418d2e4119469b0e6691cc5937663b33cd06fc4787b5c7fabaffd4f364774fc49b4313a2a8aee71a38d7b4b1d9d0
+  data.tar.gz: 184d0fe60b715ec9e90c39520b54eba1045e13c2247c35ec849d885aa371d7cfcbd510a4c98d1ffaa4f011d3fd7b661b8225c71431f3a1e735218b38cde19840

data/exe/ctrs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "containers"
+
+Containers::CLI.start(ARGV)

data/lib/containers/cli.rb

@@ -1,141 +1,58 @@
 # frozen_string_literal: true
 
+require "pry-byebug"
 require "thor"
 require "rainbow"
-require_relative "./generator"
+require "active_support/all"
+require_relative "concerns/commandable"
+require_relative "concerns/configurable"
+require_relative "generator/cli"
 
 module Containers
   class CLI < Thor
-    COMMAND_PREFIX = "▶"
+    include Commandable
+    include Configurable
 
-    alias_method :execute, :exec
+    Dir["commands/**/*.rb", base: __dir__].each { |f| require_relative f }
 
     desc "generate", "Commands used to generate files for the project"
-    subcommand "generate", Generator
+    subcommand "generate", Generator::CLI
 
-    desc "up", "Brings up the environment defined in docker-compose.yml"
-    def up(*args)
-      execute_command "docker compose up -d #{args.join " "}"
-    end
-
-    desc "down", "Tears down the environment defined in docker-compose.yml"
-    def down(*args)
-      execute_command "docker compose down #{args.join " "}"
-    end
-
-    desc "list", "Lists all containers for this project"
-    method_option :detailed, type: :boolean, aliases: "-d", desc: "List detailed container information"
-    method_option :service, type: :boolean, aliases: "-s", desc: "List container service names"
-    def list(*args)
-      return execute_command "docker ps -a | grep #{project_name}" if options[:detailed]
-
-      if options[:service]
-        command = "containers list -f"
-        puts_command "#{command} | #{Rainbow("(strip project name)").green.faint}"
-        list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(COMMAND_PREFIX) }
-        puts list.map { |item| item.gsub(/\A#{project_name}-|\s/, "") }.sort.join("\n")
-        return
-      end
-
-      command = "containers list -d"
-      puts_command "#{command} | #{Rainbow("(strip docker details)").green.faint}"
-      list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(COMMAND_PREFIX) }
-      puts list.map { |item| item.split(" ").last.strip }.sort.join("\n")
-    end
-
-    desc "inspect", "Inspects a container"
-    method_option :container, type: :string, aliases: "-c", required: true, desc: "The short name for the container"
-    def inspect(*args)
-      execute_command "docker inspect #{args.join " "} #{project_name}-#{options[:container]}"
-    end
-
-    desc "attach", "Attaches to a running container"
-    method_option :container, type: :string, aliases: "-c", required: true, desc: "The short name for the container"
-    def attach(*args)
-      execute_command "docker attach #{project_name}-#{options[:container]} #{args.join " "}"
-    end
-
-    desc "exec", "Executes a command in a container"
-    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
-    def exec(*args)
-      options[:container] = "shell" if options[:container].to_s.strip == ""
-      execute_command "docker exec -it #{project_name}-#{options[:container]} #{args.join " "}"
-    end
-
-    desc "tail", "Tails container logs"
-    method_option :container, type: :array, aliases: "-c", required: true, desc: "The short name for the container (also supports a list of names)"
-    def tail(*args)
-      args << "--since 5m" unless args.include?("--since")
-      execute_command "docker compose logs #{args.join " "} -f #{options[:container].join " "}"
-    end
+    protected
 
-    desc "start", "Starts container(s)"
-    method_option :container, type: :string, aliases: "-c", desc: "The short name for the container"
-    def start(*args)
-      return execute_command "docker start #{args.join " "} #{project_name}-#{options[:container]}" if options[:container]
-      container_names.each { |c| execute_command "docker start #{args.join " "} #{c}", replace_current_process: false }
+    def container_name(service_name)
+      service_name ||= docker_default_service
+      return nil unless service_name
+      "#{app_name}-#{service_name}"
     end
 
-    desc "stop", "Stops container(s)"
-    method_option :container, type: :string, aliases: "-c", desc: "The short name for the container"
-    def stop(*args)
-      return execute_command "docker stop #{args.join " "} #{project_name}-#{options[:container]}" if options[:container]
-      container_names.each { |c| execute_command "docker stop #{args.join " "} #{c}", replace_current_process: false }
+    def service_name(container_name)
+      return nil unless container_name
+      container_name.sub(/\A#{app_name}-/, "")
     end
 
-    desc "restart", "Restarts container(s)"
-    method_option :container, type: :array, aliases: "-c", desc: "A list of container short names"
-    def restart(*args)
-      containers = options[:container] || container_names
-      containers.each { |c| execute_command "docker restart #{args.join " "} #{c}", replace_current_process: false }
-    end
-
-    desc "bash", "Starts a bash shell"
-    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
-    def bash(*args)
-      execute_command "containers exec -c #{options[:container]} bash #{args.join " "}"
-    end
-
-    desc "bundle", "Runs the bundle command"
-    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
-    def bundle(*args)
-      execute_command "containers exec -c #{options[:container]} bundle #{args.join " "}"
-    end
-
-    desc "yarn", "Runs the yarn command"
-    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
-    def yarn(*args)
-      execute_command "containers exec -c #{options[:container]} yarn #{args.join " "}"
-    end
-
-    desc "rails", "Runs the Rails command"
-    method_option :container, type: :string, aliases: "-c", default: "shell", desc: "The short name for the container"
-    def rails(*args)
-      execute_command "containers bundle -c #{options[:container]} exec rails #{args.join " "}"
+    def service_names
+      `containers list -s`.split("\n").reject do |line|
+        line.nil? || line.empty? || line.include?(Containers::Commandable::PREFIX)
+      end
     end
 
-    private
-
     def container_names
-      `containers list -f`.split("\n")
-    end
-
-    def project_name
-      squish(File.basename(Dir.pwd)).gsub(/\s|_/, "-")
-    end
-
-    def squish(string)
-      string.gsub(/\s+/, " ").strip
+      `containers list`.split("\n").reject do |line|
+        line.nil? || line.empty? || line.include?(Containers::Commandable::PREFIX)
+      end
     end
 
-    def execute_command(command, replace_current_process: true)
-      command = squish(command)
-      puts_command command
-      replace_current_process ? execute(command) : puts(`#{command}`)
+    def requested_container_names
+      return options[:container].compact if options[:container]
+      return requested_service_names.map { |name| container_name name }.compact if options[:service]
+      container_names
     end
 
-    def puts_command(command)
-      puts "#{Rainbow(COMMAND_PREFIX).green.faint} #{Rainbow(command).green.bright}"
+    def requested_service_names
+      return options[:service].compact if options[:service]
+      return requested_container_names(options).map { |name| service_name name }.compact if options[:container]
+      service_names
     end
   end
 end

data/lib/containers/commands/attach.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "attach", "Attaches to a running container"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def attach(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "docker attach #{container} #{args.join " "}"
+  end
+end

data/lib/containers/commands/bash.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "bash", "Starts a bash shell"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def bash(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers exec -c #{container} bash #{args.join " "}"
+  end
+end

data/lib/containers/commands/bin.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "bin", "Runs executables in the ./bin directory"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def bin(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers exec -c #{container} bin/#{args.join " "}"
+  end
+end

data/lib/containers/commands/down.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "down", "Tears down the environment defined in docker-compose.yml"
+  def down(*args)
+    execute_command "docker compose #{docker_compose_files.map { |f| "-f #{f}" }.join " "} down #{args.join " "}"
+  end
+end

data/lib/containers/commands/exec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "exec", "Executes a command in a container"
+  long_desc "Also aliased as `x` for convenience"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def exec(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "docker exec -it #{container} #{args.join " "}"
+  end
+
+  map x: :exec
+end

data/lib/containers/commands/inspect.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "inspect", "Inspects a container"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def inspect(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "docker inspect #{args.join " "} #{container}"
+  end
+end

data/lib/containers/commands/list.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "list", "Lists all containers for this project"
+  method_option :detailed, type: :boolean, aliases: "-d", desc: "List detailed container information"
+  method_option :service, type: :boolean, aliases: "-s", desc: "List container service names"
+  def list(*args)
+    return execute_command "docker ps -a | grep #{app_name}" if options[:detailed]
+
+    if options[:service]
+      command = "containers list"
+      puts_command "#{command} | #{Rainbow("(strip app_name)").green.faint}"
+      list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(PREFIX) }
+      puts list.map { |item| item.gsub(/\A#{app_name}-|\s/, "") }.sort.join("\n")
+      return
+    end
+
+    command = "containers list -d"
+    puts_command "#{command} | #{Rainbow("(strip docker details)").green.faint}"
+    list = `#{command}`.split("\n").reject { |item| item.strip == "" || item.include?(PREFIX) }
+    puts list.map { |item| item.split(" ").last.strip }.sort.join("\n")
+  end
+end

data/lib/containers/commands/rails/rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "rails", "Runs the Rails command"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def rails(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers bundle -c #{container} exec rails #{args.join " "}"
+  end
+end

data/lib/containers/commands/restart.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "restart", "Restarts container(s)"
+  method_option :container, type: :array, aliases: "-c", desc: "A list of container names (space delimited)"
+  method_option :service, type: :array, aliases: "-s", desc: "A list of service names (space delimited)"
+  def restart(*args)
+    requested_container_names.each do |container_name|
+      execute_command "docker restart #{args.join " "} #{container_name}", replace_current_process: false
+    end
+  end
+end

data/lib/containers/commands/ruby/bundle.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "bundle", "Runs the bundle command"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def bundle(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers exec -c #{container} bundle #{args.join " "}"
+  end
+end

data/lib/containers/commands/ruby/rake.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "rake", "Runs ruby's rake command"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def rake(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers exec -c #{container} rake #{args.join " "}"
+  end
+end

data/lib/containers/commands/start.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "start", "Starts container(s)"
+  method_option :container, type: :array, aliases: "-c", desc: "A list of container names (space delimited)"
+  method_option :service, type: :array, aliases: "-s", desc: "A list of service names (space delimited)"
+  def start(*args)
+    requested_container_names.each do |container_name|
+      execute_command "docker start #{args.join " "} #{container_name}", replace_current_process: false
+    end
+  end
+end

data/lib/containers/commands/stop.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "stop", "Stops container(s)"
+  method_option :container, type: :array, aliases: "-c", desc: "A list of container names (space delimited)"
+  method_option :service, type: :array, aliases: "-s", desc: "A list of service names (space delimited)"
+  def stop(*args)
+    requested_container_names.each do |container_name|
+      execute_command "docker stop #{args.join " "} #{container_name}", replace_current_process: false
+    end
+  end
+end

data/lib/containers/commands/tail.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "tail", "Tails container logs"
+  method_option :container, type: :array, aliases: "-c", desc: "A list of container names (space delimited)"
+  method_option :service, type: :array, aliases: "-s", desc: "A list of service names (space delimited)"
+  def tail(*args)
+    args << "--since 5m" unless args.include?("--since")
+    execute_command "docker compose #{docker_compose_files.map { |f| "-f #{f}" }.join " "} logs #{args.join " "} -f #{requested_service_names.join " "}"
+  end
+end

data/lib/containers/commands/up.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "up", "Brings up the environment defined in docker-compose.yml"
+  def up(*args)
+    execute_command "docker compose #{docker_compose_files.map { |f| "-f #{f}" }.join " "} up -d #{args.join " "}"
+  end
+end

data/lib/containers/commands/yarn/yarn.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Containers::CLI < Thor
+  desc "yarn", "Runs the yarn command"
+  method_option :container, type: :string, aliases: "-c", desc: "The container name"
+  method_option :service, type: :string, aliases: "-s", desc: "The service name"
+  def yarn(*args)
+    container = options[:container] || container_name(options[:service])
+    execute_command "containers exec -c #{container} yarn #{args.join " "}"
+  end
+end

data/lib/containers/concerns/commandable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Containers::Commandable
+  extend ActiveSupport::Concern
+
+  PREFIX = "▶"
+
+  alias_method :execute, :exec
+
+  def puts_command(command)
+    puts "#{Rainbow(PREFIX).green.faint} #{Rainbow(command).green.bright}"
+  end
+
+  def execute_command(command, replace_current_process: true)
+    command = command.squish
+    puts_command command
+    replace_current_process ? execute(command) : puts(`#{command}`)
+  end
+end

data/lib/containers/concerns/configurable.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Containers::Configurable
+  extend ActiveSupport::Concern
+
+  def self.gitname
+    email = begin
+      `git config --get user.email`.strip
+    rescue
+      nil
+    end
+    email&.split("@")&.first || "example"
+  end
+
+  DEFAULT_CONFIGURATION = {
+    "organization" => {
+      "name" => gitname
+    },
+    "app" => {
+      "name" => File.basename(Dir.pwd).parameterize,
+      "directory" => "."
+    },
+    "docker" => {
+      "directory" => ".",
+      "default_service" => nil,
+      "compose_files" => ["docker-compose.yml"]
+    }
+  }.freeze
+
+  def organization_name
+    configuration["organization"]["name"]
+  end
+
+  def app_name
+    configuration["app"]["name"]
+  end
+
+  def app_directory
+    configuration["app"]["directory"]
+  end
+
+  def docker_directory
+    configuration["docker"]["directory"]
+  end
+
+  def docker_default_service
+    configuration["docker"]["default_service"]
+  end
+
+  def docker_compose_files
+    configuration["docker"]["compose_files"]
+  end
+
+  def configuration
+    @configuration ||=
+      if File.exist?(".containers.yml")
+        YAML.load_file(".containers.yml")
+      else
+        DEFAULT_CONFIGURATION
+      end
+  end
+end

data/lib/containers/generator/cli.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "erb"
+require "net/http"
+require "uri"
+
+module Containers::Generator
+  class CLI < Thor
+    include Containers::Commandable
+    Dir["commands/**/*.rb", base: __dir__].each { |f| require_relative f }
+
+    protected
+
+    def template_path(template_name)
+      Pathname.new(__dir__).join "templates/#{template_name}.erb"
+    end
+
+    def template_string(template_name)
+      File.read template_path(template_name)
+    end
+
+    def template(template_name)
+      ERB.new template_string(template_name), trim_mode: "-"
+    end
+
+    def render_template(template_name, vars = {})
+      view = Struct.new(*vars.keys).new(*vars.values).instance_eval { binding }
+      template(template_name).result view
+    end
+
+    def render_external_template(template, vars = {})
+      view = Struct.new(*vars.keys).new(*vars.values).instance_eval { binding }
+
+      template_string = if template.start_with?("http")
+        Net::HTTP.get URI.parse(template)
+      else
+        File.read template
+      end
+
+      ERB.new(template_string).result view
+    end
+  end
+end

data/lib/containers/generator/commands/compose.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require_relative "../../concerns/configurable"
+
+class Containers::Generator::CLI < Thor
+  include ::Containers::Configurable
+
+  desc "compose", "Creates a docker-compose.yml file for the project"
+  method_option :template, type: :string, aliases: "-t", desc: "The docker-compose.yml template to use (can be a local file or a URL)"
+  def compose
+    FileUtils.mkdir_p docker_directory
+    path = File.expand_path("#{docker_directory}/docker-compose.yml")
+    exists = File.exist?(path)
+    original = File.read(path) if exists
+
+    continue = if exists
+      ask("#{Rainbow("docker-compose.yml already exists").red} Overwrite?", default: "n").to_s.upcase == "Y"
+    else
+      true
+    end
+
+    return unless continue
+
+    FileUtils.rm_f path
+
+    vars = {
+      organization: {name: ask("What is the organization name?", default: organization_name).to_s},
+      app: {
+        name: ask("What is the app name?", default: app_name).to_s.parameterize,
+        directory: File.expand_path(ask("What is the path to the app directory? ", default: app_directory).to_s)
+      }
+    }
+
+    contents = if options[:template]
+      render_external_template options[:template], vars
+    else
+      render_template "docker-compose.yml", vars
+    end
+
+    puts_command Rainbow("(Create #{path})").green.faint
+    File.write path, contents
+    puts Rainbow("docker-compose.yml created successfully").green.bright
+  rescue => error
+    puts Rainbow("Unexpected error! #{error.message}").red.bright
+    if exists && original
+      puts Rainbow("Restoring the original file.").green.faint
+      File.write path, original
+    end
+  end
+end

data/lib/containers/generator/commands/config.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../../concerns/configurable"
+
+class Containers::Generator::CLI < Thor
+  include ::Containers::Configurable
+
+  desc "config", "Creates a .containers.yml config file for the project"
+  def config
+    path = File.expand_path(".containers.yml")
+    exists = File.exist?(path)
+    original = File.read(path) if exists
+
+    continue = if exists
+      ask("#{Rainbow(".containers.yml already exists").red} Overwrite?", default: "n").to_s.upcase == "Y"
+    else
+      true
+    end
+
+    return unless continue
+
+    FileUtils.rm_f path
+
+    vars = {
+      organization_name: ask("What is the organization name?", default: organization_name).to_s.parameterize,
+      app_name: ask("What is the app name?", default: app_name).to_s.parameterize,
+      app_directory: File.expand_path(ask("What is the path to the app directory? ", default: app_directory).to_s),
+      docker: {
+        directory: File.expand_path(ask("What is the path to the Docker directory? ", default: docker_directory).to_s),
+        default_service: ask("What is the default Docker service?", default: docker_default_service).to_s,
+        compose_files: docker_compose_files
+      }
+    }
+
+    File.write path, render_template("containers.yml", vars)
+  rescue => error
+    puts Rainbow("Unexpected error! #{error.message}").red.bright
+    if exists && original
+      puts Rainbow("Restoring the original file.").green.faint
+      File.write path, original
+    end
+  end
+end