locport 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60fe13278bf753c5ca419b16ed83d731d1234c8418cde3fad2219e072c58c933
+  data.tar.gz: 195ea9c9149cf05f67f67648ebccf8bad93665e18984bbffb6af97efcd804507
+SHA512:
+  metadata.gz: '0246848221d73ee34faec98b8da66622ef74364dc7f96c9831b6f0c763f6b8ca4b19c056c65158a00c41763defac07838e3bbceb80c608b3724625ad39e1b567'
+  data.tar.gz: 9b4e16a6b15447a1ab4d1aaeee8170e0f9381c3819008f45ac2c17fa8ed1636d60dd6e87ea4c2a228138864d00afd242d1ef071765b3c53b1e4ca3cd54efe46a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Starsi
+
+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/locport

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "locport"
+
+Locport::Main.start(ARGV)

data/lib/locport.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require "thor"
+require "fileutils"
+require "pathname"
+
+APP_NAME = "locport"
+DATA_FILE = "projects"
+DOTFILE = ".localhost"
+PORT_RANGE = (30_000..60_000)
+
+module Locport
+  class Main < Thor
+    default_task :list
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "index [PATH]", "Index a project"
+    def index(path = Dir.pwd, silent: false)
+      project_path = Pathname.new(path).cleanpath
+      dotfile_path = project_path.join(DOTFILE)
+
+      unless File.exist?(dotfile_path)
+        say_error "#{dotfile_path} file doesn't exist", :red
+        say_error "You can create it from within that directory with `locport add`"
+        exit 1
+      end
+
+      append_to_projects project_path.to_s
+
+      unless silent
+        say "Indexing ", :green
+        say project_path
+      end
+    end
+
+    desc "add [HOST[:PORT]]", "Add a new host to .localhost file. \
+      Without arguments current directory name will be used and random port number assigned."
+    def add(host = "#{File.basename(Dir.pwd)}.localhost")
+      host_with_port, port = ensure_port(host.strip)
+
+      # if taken_by_path = port_taken?(port)
+      #   say_error "Port #{port} is already taken by #{taken_by_path}"
+      #   exit 1
+      # end
+
+      append_to_dotfile host_with_port
+      index silent: true
+
+      say "#{host_with_port} ", :bold 
+      say "added ", :green
+      say "to #{DOTFILE}"
+    rescue HostAlreadyAddedError => e
+      say_error e.message, :red
+      exit 1
+    end
+
+    desc "list", "List indexed projects, hosts and ports"
+    def list
+      table_data = []
+      used_ports = []
+      used_hosts = []
+      conflicts_found = false
+
+      projects.each do |(dir, host, port)|
+        table_data << [ dir.sub(Dir.home, "~"), "http://#{host}:#{port}" ]
+
+        if used_ports.include?(port)
+          conflicts_found = true
+          table_data << [ "", "╰ Port used before" ]
+        else
+          used_ports << port
+        end
+
+        if used_hosts.include?(host)
+          conflicts_found = true
+          table_data << [ "", "╰ Host used before" ]
+        else
+          used_hosts << host
+        end
+      end
+
+      print_table [ [ "Project", "URL" ] ] + table_data, borders: true
+
+      if conflicts_found
+        say "Conflicts found!", :red
+        exit 1
+      else
+        say "All hosts and ports are unique ✓", :green
+      end
+    end
+
+    desc "info", "Display tool information"
+    def info
+      say "Projects index: #{projects_file_path}"
+    end
+
+    class HostAlreadyAddedError < StandardError; end
+
+    private
+      def projects
+        @projects ||= load_projects
+      end
+
+      def load_projects
+        result = []
+        @used_ports = []
+        @used_hosts = []
+
+        File.read(projects_file_path).lines.each do |project_path|
+          project_path = project_path.strip
+          dotfile_path = Pathname.new(project_path).join(DOTFILE)
+          next unless File.exist?(dotfile_path)
+
+          hosts = File.read(dotfile_path).lines
+
+          hosts.each do |host_with_port|
+            host, port = host_with_port.strip.split(":")
+            result << [ project_path, host, port ]
+
+            unless @used_ports.include?(port)
+              @used_ports << port
+            end
+
+            unless @used_hosts.include?(host)
+              @used_hosts << host
+            end
+          end
+        end
+
+        result
+      end
+
+      def ensure_port(host)
+        if host =~ /:([\d]+)$/
+          [ host, $1.to_i ]
+        else
+          port = rand PORT_RANGE
+          [ "#{host}:#{port}", port ]
+        end
+      end
+
+      def storage_base_dir
+        if Gem.win_platform?
+          ENV["APPDATA"] || File.join(Dir.home, "AppData", "Roaming")
+        else
+          ENV["XDG_DATA_HOME"] || File.join(Dir.home, ".local", "share")
+        end
+      end
+
+      def storage_dir
+        File.join(storage_base_dir, APP_NAME)
+      end
+
+      def projects_file_path
+        FileUtils.mkdir_p(storage_dir)
+        File.join(storage_dir, DATA_FILE)
+      end
+
+      def append_to_projects(line)
+        path_present = File.exist?(projects_file_path) && File.read(projects_file_path).lines.any? do
+          it.strip == line
+        end
+
+        return if path_present 
+
+        File.open(projects_file_path, "a") do |f|
+          f.puts(line)
+        end
+      end
+
+      def append_to_dotfile(line)
+        host = line.split(":").first
+
+        host_present = File.exist?(DOTFILE) && File.read(DOTFILE).lines.any? do
+          it.split(":").first == host
+        end
+
+        if host_present
+          raise HostAlreadyAddedError, "#{host} is already present in #{DOTFILE}"
+        end
+
+        File.open(DOTFILE, "a") do |f|
+          f.puts(line)
+        end
+      end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: locport
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Starsi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Overview of localhost ports used across projects. Prevent conflicts.
+email: klevo@klevo.sk
+executables:
+- locport
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/locport
+- lib/locport.rb
+homepage: https://github.com/klevo/locport
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+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.7.1
+specification_version: 4
+summary: localhost port management
+test_files: []