overmind 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a0f475e911384af6f69897158bf8cd8418451e1b7b995b0ade28a59f8a772c4
+  data.tar.gz: 800847132dd8cbd2652644d352034868ca611179165bdbdd9b811df2158a43d5
+SHA512:
+  metadata.gz: 61911ff8ef159b205a7b340c88a2bfb8e914e7152f9253ccdc8272ead0d2a122d2e9fb774530df5f43e9a5b755984dea9f766556afc15e29879e34f1098c2dd8
+  data.tar.gz: 5e5762893c708b8ce597993d0ab47568b045980361115100c7ed23b0944706b6c0de3de3b8e27d0f2980c3cef8f15536c0a281a603eb024434d29c33a4805de8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 prog-supdex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/overmind

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'overmind/cli'
+
+begin
+  cli = Overmind::CLI.new
+  exit_code = cli.run(ARGV)
+  exit exit_code
+rescue StandardError => e
+  warn e.message
+  exit 1
+end

data/lib/overmind/cli.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Overmind
+  # Command-line interface for running golang library Overmind
+  # It ensures that the necessary dependencies, such as tmux, are present
+  # and runs Overmind with any provided arguments.
+  class CLI
+    SUPPORTED_OS_REGEX = /darwin|linux|bsd/i
+    # Path to the library's executable files
+    LIBRARY_PATH = File.expand_path("#{File.dirname(__FILE__)}/../../libexec")
+    OVERMIND_PATH = "#{LIBRARY_PATH}/overmind"
+    TMUX_FOLDER_PATH = "#{LIBRARY_PATH}/prebuilt-tmux/bin"
+    TMUX_PATH = "#{TMUX_FOLDER_PATH}/tmux"
+
+    def run(args = [])
+      os_validate!
+      validate_tmux_present!
+      validate_overmind_present!
+
+      # Ensures arguments are properly quoted if they contain spaces
+      args = args.map { |x| x.include?(" ") ? "'#{x}'" : x }
+
+      # Use prebuild tmux if found
+      path_with_tmux = File.exist?(TMUX_PATH) ? "#{ENV["PATH"]}:#{TMUX_FOLDER_PATH}" : ENV["PATH"]
+
+      # Spawns the Overmind process with modified PATH if necessary
+      pid = spawn({"PATH" => path_with_tmux}, "#{OVERMIND_PATH} #{args.join(" ")}")
+
+      Process.wait(pid)
+
+      $?.exitstatus
+    end
+
+    private
+
+    # Checks if the current OS is supported based on a regex match
+    def os_supported?
+      RUBY_PLATFORM.match?(SUPPORTED_OS_REGEX)
+    end
+
+    # Checks if tmux is installed either globally or as a prebuilt binary
+    def tmux_installed?
+      system("which tmux") || File.exist?(TMUX_PATH)
+    end
+
+    # Checks if the Overmind executable is present
+    def overmind_installed?
+      File.exist?(OVERMIND_PATH)
+    end
+
+    # Validates the operating system and aborts with an error message if unsupported
+    def os_validate!
+      return if os_supported?
+
+      abort_with_message("Error: This gem supports Linux, *BSD, and macOS only.")
+    end
+
+    # Validates the presence of tmux and aborts with an error message if not found
+    def validate_tmux_present!
+      return if tmux_installed?
+
+      abort_with_message(<<~MSG)
+        Error: tmux not found. Please ensure tmux is installed and available in PATH.
+        If tmux is not installed, you can usually install it using your package manager. For example:
+
+          # For Ubuntu/Debian
+          sudo apt-get install tmux
+        #{"  "}
+          # For macOS
+          brew install tmux
+        #{"  "}
+          # For FreeBSD
+          sudo pkg install tmux
+
+        Installation commands might vary based on your operating system and its version.#{" "}
+        Please consult your system's package management documentation for the most accurate instructions.
+      MSG
+    end
+
+    # Validates the presence of Overmind and aborts with an error message if not found
+    def validate_overmind_present!
+      return if overmind_installed?
+
+      abort_with_message("Error: Invalid platform. Overmind wasn't built for #{RUBY_PLATFORM}")
+    end
+
+    # Aborts execution with a given error message
+    def abort_with_message(message)
+      warn "\e[31m#{message}\e[0m"
+      exit 1
+    end
+  end
+end

data/lib/overmind/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Overmind
+  VERSION = "0.1.0"
+end

data/lib/overmind.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+module Overmind; end

data/overmind.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/overmind/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "overmind"
+  spec.version = Overmind::VERSION
+  spec.authors = ["prog-supdex"]
+  spec.email = ["symeton@gmail.com"]
+
+  spec.summary = "Overmind is a process manager for Procfile-based applications and tmux."
+  spec.description = "Overmind is a process manager for Procfile-based applications and tmux."
+  spec.homepage = "https://github.com/DarthSim/overmind"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DarthSim/overmind"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir["bin/*", "lib/**/*.rb", "libexec/**/*", "overmind.gemspec", "LICENSE.txt"]
+  spec.bindir = "bin"
+  spec.executables = ["overmind"]
+  spec.require_paths = %w[lib libexec]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: overmind
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- prog-supdex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Overmind is a process manager for Procfile-based applications and tmux.
+email:
+- symeton@gmail.com
+executables:
+- overmind
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- bin/overmind
+- lib/overmind.rb
+- lib/overmind/cli.rb
+- lib/overmind/version.rb
+- libexec/overmind
+- libexec/prebuilt-tmux/bin/tmux
+- overmind.gemspec
+homepage: https://github.com/DarthSim/overmind
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DarthSim/overmind
+  source_code_uri: https://github.com/DarthSim/overmind
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- libexec
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key: 
+specification_version: 4
+summary: Overmind is a process manager for Procfile-based applications and tmux.
+test_files: []