locport 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc86bc82dc0d1f5819e88fded771add0a1a6d43f82f9dc2b6a771e6b2b9b6f26
-  data.tar.gz: e3a28a505d1db3509832c0ea57be725fafc5b0a7a0d72fcdbf9e4583e8e933b9
+  metadata.gz: 3cbc4ad1881fb933fd3582c13cd2ed6c4d881b71d19430451c0ccb4f882c299a
+  data.tar.gz: abe62ddb5fa288edbb3376c0137558a90d84ce93906e638697399d3ac5077ad8
 SHA512:
-  metadata.gz: 27754a18750c34bd1505fb6fe04ada64e94e3fee9270016cbc116838f43ae697022c0289328efc50caed34d778989a70659e52e5078a6400d6b474d942c8f25e
-  data.tar.gz: c554937dd1c1a904a502ee2a6b151543b291262f767585ce8ac388b8f533de85c22c40f7a11580ef43b1784fde4d07154acb2a4c840f603c5b0e249a410dbf00
+  metadata.gz: 568880abea66ec3c00d68ac0a3c5c02300fa348d8a2ba729c0a2cfbe805a2d23e0ccef8d88c71532634e44e03a2c4be97cb9b4fe21d257c81389bda2a67adecc
+  data.tar.gz: 8fe1b19ea6f27c437e54302b7b4c06f6aeadfaecfa204f81cd9fb66ec7c8b7db5cc9f2f9c9c0d1cb0a9f6e281d60ca43e8d223aadf1ed585a7568ad55170b41f

data/lib/locport/indexer.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require "find"
+require "socket"
+require "fileutils"
+require "pathname"
+
+module Locport
+  Address = Struct.new(:host, :port, :path, :line_number, :host_conflicts, :port_conflicts)
+
+  class Indexer
+    APP_NAME = "locport"
+    DOTFILE = ".localhost"
+    DATA_FILE = "projects"
+    PORT_RANGE = (30_000..60_000)
+
+    attr_reader :dotfiles, :projects, :addresses
+
+    def initialize(home_path: Dir.home, storage_base_dir: default_storage_base_dir)
+      @home_path = home_path
+      @storage_base_dir = storage_base_dir
+      @dotfiles = load_dotfiles
+      @projects = load_projects
+    end
+
+    def index(path, recursive: false, shell: nil)
+      start_path = File.expand_path path.to_s
+
+      [].tap do |result|
+        begin
+          Find.find(start_path) do |path|
+            Find.prune if !recursive && File.directory?(path) && path.size > start_path.size
+
+            if File.basename(path) == DOTFILE && File.file?(path)
+              result << Pathname.new(path)
+
+              shell&.indent do
+                shell&.say "#{path} "
+              end
+              shell&.say "added", :green
+            end
+          end
+        rescue Errno::ENOENT
+        end
+
+        @dotfiles = (@dotfiles + result).uniq.sort
+      end
+    end
+
+    def load_dotfiles
+      File.read(storage_path).lines.map(&:strip).reject(&:empty?).map { |path| Pathname.new(path).join(DOTFILE) }
+    rescue Errno::ENOENT
+      []
+    end
+
+    def load_projects
+      @projects = {}.tap do |result|
+        @addresses = []
+
+        @dotfiles.each do |path|
+          File.read(path).each_line.with_index do |line, index|
+            dir = File.dirname path.to_s
+
+            key, source = cannonize_project_dir dir
+            result[key] ||= []
+
+            if line.strip =~ /^(.+):(\d+)$/
+              address = Address.new($1, $2.to_i, source, index + 1)
+              result[key] << address
+              @addresses << address
+            end
+          end
+        rescue Errno::ENOENT
+        end
+
+        reveal_address_conflicts
+      end.sort.to_h
+    end
+
+    def port_listening?(port)
+      Socket.tcp("127.0.0.1", port, connect_timeout: 0.01) {}  # 10ms timeout
+      true
+    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError
+      false
+    end
+
+    def save
+      FileUtils.mkdir_p storage_dir
+      File.write storage_path, @dotfiles.map { |path| File.dirname(path) }.join("\n") + "\n"
+    end
+
+    def default_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 create_address(value, dir: Dir.pwd)
+      _, source = cannonize_project_dir dir
+
+      address = if value.strip =~ /^(.+):(\d+)$/
+        Address.new($1, $2.to_i, source)
+      else
+        Address.new(value, find_unused_port, source)
+      end
+
+      @addresses << address
+      reveal_address_conflicts
+
+      address
+    end
+
+    def append_address_to_dotfile(address, dir: Dir.pwd)
+      _, _, fullpath = cannonize_project_dir dir
+
+      File.open(fullpath, "a") do |file|
+        file.puts("#{address.host}:#{address.port}")
+      end
+
+      index dir
+      save
+    end
+
+    def storage_path
+      File.join storage_dir, DATA_FILE
+    end
+
+    private
+      def storage_dir
+        File.join @storage_base_dir, APP_NAME
+      end
+
+      def cannonize_project_dir(dir)
+        key = if dir.start_with?(@home_path.to_s)
+          dir.sub(@home_path.to_s, "~")
+        else
+          dir
+        end
+
+        source = "#{key}/#{DOTFILE}"
+        fullpath = "#{dir}/#{DOTFILE}"
+
+        [ key, source, fullpath ]
+      end
+
+      def reveal_address_conflicts
+        @addresses.each do |address|
+          address.host_conflicts = nil
+          address.port_conflicts = nil
+        end
+
+        @addresses.each do |address|
+          @addresses.each do |other_address|
+            next if address == other_address
+
+            if address.host == other_address.host
+              address.host_conflicts ||= []
+              address.host_conflicts << other_address
+            end
+
+            if address.port == other_address.port
+              address.port_conflicts ||= []
+              address.port_conflicts << other_address
+            end
+          end
+        end
+      end
+
+      def find_unused_port
+        loop do
+          port = rand PORT_RANGE
+          return port unless @addresses.any? { |address| address.port == port } || port_listening?(port)
+        end
+      end
+  end
+end

data/lib/locport.rb

@@ -1,205 +1,108 @@
 # frozen_string_literal: true
 
 require "thor"
-require "fileutils"
-require "pathname"
-
-APP_NAME = "locport"
-DATA_FILE = "projects"
-DOTFILE = ".localhost"
-PORT_RANGE = (30_000..60_000)
+require "locport/indexer"
 
 module Locport
   class Main < Thor
+    COLOR_FAINT  = "\e[2m"
+
     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
+    desc "index [PATH]", "Add project path(s) to locport"
+    method_option :recursive, type: :boolean, default: false, aliases: "-r"
+    def index(*paths)
+      paths.each do |path|
+        say "Indexing "
+        say path, :blue
+        indexer.index(path, recursive: options.recursive, shell:)
       end
 
-      append_to_projects project_path.to_s
+      indexer.save
 
-      unless silent
-        say "Indexing ", :green
-        say project_path
-      end
+      say "Done ✓", :green
     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)
-      host = host_with_port.split(":").first
-
-      if used_ports.include?(port)
-        say_error "Port #{port} is "
-        say_error "already used. ", :red
-        say_error "See `locport list`"
-        exit 1
-      end
+      address = indexer.create_address host
 
-      if used_hosts.include?(host)
-        say_error "Host '#{host}' is " 
-        say_error "already used. ", :red
-        say_error "See `locport list`"
+      say_address_conflicts address
+      
+      if @conflicts_found
+        say "Can't add due to conflicts"
         exit 1
       end
 
-      append_to_dotfile host_with_port
-      index silent: true
+      indexer.append_address_to_dotfile address
 
-      say "#{host_with_port} ", :bold 
-      say "added ", :green
-      say "to #{DOTFILE}"
+      say "#{address.host}:#{address.port} ", :bold 
+      say "added ✓", :green
     end
 
     desc "list", "List indexed projects, hosts and ports"
     def list
-      table_data = []
-      used_ports = []
-      used_hosts = []
-      conflicts_found = false
+      indexer.projects.each do |dir, addresses|
+        say dir, :blue
 
-      projects.each do |(dir, host, port)|
-        table_data << [ dir.sub(Dir.home, "~"), "http://#{host}:#{port}" ]
+        shell.indent do
+          addresses.each do |address|
+            port_color = indexer.port_listening?(address.port) ? :green : COLOR_FAINT
+            say "• ", port_color
 
-        if used_ports.include?(port)
-          conflicts_found = true
-          table_data << [ "", "╰ Port used before" ]
-        else
-          used_ports << port
-        end
+            shell.indent(-1) do
+              say [ display_host(address.host), address.port ].join(":")
+            end
 
-        if used_hosts.include?(host)
-          conflicts_found = true
-          table_data << [ "", "╰ Host used before" ]
-        else
-          used_hosts << host
+            say_address_conflicts address
+          end
         end
       end
 
-      print_table [ [ "Project", "URL" ] ] + table_data, borders: true
-
-      if conflicts_found
-        say "Conflicts found!", :red
+      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}"
+      say "Index file: #{indexer.storage_path}"
     end
 
     private
-      def projects
-        load_projects
-        @projects 
-      end
-
-      def used_ports
-        load_projects
-        @used_ports
-      end
-
-      def used_hosts
-        load_projects
-        @used_hosts
+      def indexer
+        @indexer ||= Indexer.new
       end
 
-      def load_projects
-        @projects = []
-        @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(":")
-            port = port.to_i
-            @projects << [ project_path, host, port ]
-
-            unless @used_ports.include?(port)
-              @used_ports << port
-            end
-
-            unless @used_hosts.include?(host)
-              @used_hosts << host
-            end
-          end
-        end
-
-        @projects
-      rescue Errno::ENOENT
-        @projects
-      end
-
-      def ensure_port(host)
-        if host =~ /:([\d]+)$/
-          [ host, $1.to_i ]
-        else
-          port = find_unused_port
-          [ "#{host}:#{port}", port ]
-        end
-      end
-
-      def find_unused_port
-        loop do
-          port = rand PORT_RANGE
-          return port unless used_ports.include?(port)
-        end
-      end
-
-      def storage_base_dir
-        if Gem.win_platform?
-          ENV["APPDATA"] || File.join(Dir.home, "AppData", "Roaming")
+      def display_host(host)
+        if host.include?("://")
+          host
         else
-          ENV["XDG_DATA_HOME"] || File.join(Dir.home, ".local", "share")
+          "http://#{host}"
         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 say_address_conflicts(address)
+        if address.port_conflicts
+          @conflicts_found = true
 
-      def append_to_projects(line)
-        path_present = File.exist?(projects_file_path) && File.read(projects_file_path).lines.any? do
-          it.strip == line
+          address.port_conflicts.each do |conflicting_address|
+            say "╰ Port also at #{conflicting_address.path}:#{conflicting_address.line_number}", :red
+          end
         end
 
-        return if path_present 
+        if address.host_conflicts
+          @conflicts_found = true
 
-        File.open(projects_file_path, "a") do |f|
-          f.puts(line)
-        end
-      end
-
-      def append_to_dotfile(line)
-        File.open(DOTFILE, "a") do |f|
-          f.puts(line)
+          address.host_conflicts.each do |conflicting_address|
+            say "╰ Host also at #{conflicting_address.path}:#{conflicting_address.line_number}", :red
+          end
         end
       end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locport
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Robert Starsi
@@ -23,6 +23,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: testerobly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
 description: Overview of localhost ports used across projects. Prevent conflicts.
 email: klevo@klevo.sk
 executables:
@@ -33,6 +89,7 @@ files:
 - LICENSE
 - bin/locport
 - lib/locport.rb
+- lib/locport/indexer.rb
 homepage: https://github.com/klevo/locport
 licenses:
 - MIT
@@ -44,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="