hosts-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85b4ffe43ac4d76a38fca773d29bf8c754c4ccc6
+  data.tar.gz: 3164d63d30eebb53eaaafec6364dd854237c054e
+SHA512:
+  metadata.gz: 80ba5915bcfd43f204627d14c04c541eca372544803018467a24bc051028509636bdaef2f24e713d53102a700ecdf34c1c3111db67b694a98fc81a10955b162e
+  data.tar.gz: cdfb89302a6e8139e9eb767dffd117ccde75097d48c7339b7c67bcdabe584ceb46d7e320187ff5697e9275464fe602d45536a77ed494a01b4286b7b4b8802a57

data/bin/hosts

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Ad lib to include path
+$:.unshift File.dirname(File.expand_path(File.dirname(__FILE__))) + '/lib'
+
+# Require sub commands
+require 'Hosts/Lib/autoload.rb'
+require 'hosts.rb'
+
+Hosts.main

data/lib/Hosts/Lib/Commands/Add.rb

@@ -0,0 +1,28 @@
+include Hosts::Lib::Core
+include Hosts::Lib
+
+module Hosts::Lib::Commands
+  options_obj = Slop::Options.new suppress_errors: true
+  options_obj.banner = "Usage: hosts add [dest] [hostname [hostname [...]]]"
+
+  Add = SubCommand.new(
+    'add', # Name of the sub command
+    'Add a hosts entry. requires \'sudo\'',
+    options_obj
+  ) { |options, args|
+    unless (args.length >= 2)
+      puts options_obj.banner
+      next
+    end
+
+    hosts_file = HostsFile.new Hosts.hosts_file
+
+    hosts_file.add_entry(args[0], args[1])
+
+    puts "Added entry: #{args[0]} => #{args[1]}"
+
+    # Write changes to hosts file
+    hosts_file.flush
+  }
+  @Add
+end

data/lib/Hosts/Lib/Commands/Help.rb

@@ -0,0 +1,17 @@
+include Hosts::Lib::Core
+
+module Hosts::Lib::Commands
+  options_obj = Slop::Options.new
+
+  Help = SubCommand.new(
+    'help', # Name of the command
+    'Print the help message', # Description
+    options_obj, # Has no options
+    false
+  ) do |_options, _args|
+    Hosts.sub_commands.each do |_key, cmd|
+      cmd.print_help_message
+    end
+  end
+  @Help
+end

data/lib/Hosts/Lib/Commands/List.rb

@@ -0,0 +1,32 @@
+require 'JSON'
+
+module Hosts::Lib::Commands
+  options_obj = Slop::Options.new
+  
+  List = SubCommand.new(
+    'list', # Name of the sub command
+    'List all host entries',
+    options_obj,
+    false
+  ) { |options, args|
+    hosts_file = HostsFile.new Hosts.hosts_file
+    hosts_entries = hosts_file.get_all_entries
+    
+    longest_dest_name = 0
+
+    hosts_entries.each do |dest, hostnames|
+      if (dest.length > longest_dest_name)
+        longest_dest_name = dest.length
+      end
+    end
+
+    hosts_entries.each do |dest, hostnames|
+      hostname_f = hostnames * ", "
+
+      print "%-#{longest_dest_name}.#{longest_dest_name}s" % dest
+      print " "
+      puts "=> #{hostname_f}"
+    end
+  }
+  @List
+end

data/lib/Hosts/Lib/Commands/Rm.rb

@@ -0,0 +1,34 @@
+include Hosts::Lib::Core
+
+module Hosts::Lib::Commands
+  options_obj = Slop::Options.new
+  options_obj.banner = "Usage: hosts dest [alias]"
+
+  Rm = SubCommand.new(
+    'rm', # Name of the sub command
+    "Remove entry. Removes all entries to a 'dest' if no alias is defined. Requires 'sudo'",
+    options_obj
+  ) { |options, args|
+    # Must be right number of arguments
+    unless (args.length > 0 && args.length <= 2)
+      puts options_obj
+      next
+    end
+
+    hosts_file = HostsFile.new Hosts.hosts_file
+
+    if (args[1] != nil)
+      # rm alias
+      hosts_file.rm_alias(args[0], args[1])
+    else
+      # Remove all entries
+      # to 'dest' if alias
+      # is not defined
+      hosts_file.rm_dest_entries(args[0])
+    end
+
+    # Write changes to hosts file
+    hosts_file.flush()
+  }
+  @Rm
+end

data/lib/Hosts/Lib/Commands/Version.rb

@@ -0,0 +1,15 @@
+include Hosts::Lib::Core
+
+module Hosts::Lib::Commands
+  options_obj = Slop::Options.new
+  
+  Version = SubCommand.new(
+    'version', # Name of the sub command
+    'Print the version',
+    options_obj,
+    false
+  ) { |options, args|
+    puts Hosts::VERSION
+  }
+  @Version
+end

data/lib/Hosts/Lib/Core/HostsFile.rb

@@ -0,0 +1,161 @@
+require 'JSON'
+require 'etc'
+
+module Hosts::Lib::Core
+  class HostsFile
+    @hosts_file_path = nil
+
+    def initialize(file_path)
+      @entries = {}
+      @hosts_file_path = file_path
+      parse_file(file_path)
+    end
+
+    def parse_file(file_path)
+      newline_count = 0
+      comment_count = 0
+
+      File.readlines(file_path).each do |line|
+        # Add comments to @entries, to preserve them
+        if (/^[\s\t]*?#/ =~ line)
+          # Add comment to entries, minus the newline
+          @entries["__comment__#{comment_count}"] = { "comment" => line[0..-2] }
+          comment_count += 1
+          next
+        end
+
+        # Add empty lines to @entries, to preserve them
+        if (/^[\s\t]*?$/ =~ line)
+          @entries["__newline__#{newline_count}"] = { "newline" => "newline" }
+          newline_count += 1
+          next
+        end
+
+        # Remove comment, if there is one
+        line_and_comment = line.split("#")
+        line = line_and_comment[0]
+        comment = line_and_comment[1]
+
+        # Remove newline from comment
+        comment = comment[0..-2] if (comment != nil)
+
+        parts = line.split(/[\s\t]+/)
+
+        dest      = parts[0]
+        hostnames   = parts[1..-1]
+
+        # Remove last item if empty
+        hostnames.pop if (hostnames.length == 0)
+
+        hostnames = [hostnames] if (!hostnames.is_a?(Array))
+
+        if (hostnames == nil)
+          fail InvalidHostsFileException.new "Missing hostsname from entry declaration \n #{line}\n"
+        end
+        if (dest == nil)
+          fail InvalidHostsFileException.new "Missing destination from entry declaration \n #{line}\n"
+        end
+
+        add_entry(dest, hostnames, comment)
+      end
+    end
+
+    # Return false if the hostname
+    # was not an alias for 'dest'
+    def rm_alias(dest, hostname)
+      return false if (!@entries.has_key?(dest))
+
+      # remove hostname from dest, and return
+      # bool to indicate if it existed in the
+      # first place
+      was_deleted = @entries[dest]["hostnames"].delete(hostname) != nil;
+
+      # remove dest from @entries
+      # if it is now empty
+      if (@entries[dest]["hostnames"].length == 0)
+        @entries.delete(dest)
+      end
+
+      return was_deleted
+    end
+
+    def rm_dest_entries(dest)
+      if (@entries.has_key?(dest))
+        @entries.delete(dest)
+      end
+    end
+
+    # Add an entry.
+    # Expects to strings
+    def add_entry(dest, hostnames, comment = nil)
+      comment = "" if comment == nil
+
+      hostnames = [hostnames] if (!hostnames.is_a?(Array))
+
+      if (@entries.has_key?(dest))
+        # Add hostnames to entries, except duplicates, dont add them
+        @entries[dest]["hostnames"] = @entries[dest]["hostnames"] | hostnames
+      else
+        @entries[dest] = {"hostnames" => hostnames, "comment" => comment}
+      end
+    end
+
+    def get_all_entries()
+      _entries = {}
+      @entries.each do |dest, obj|
+        next if (!obj.has_key?("hostnames"))
+        _entries[dest] = obj["hostnames"]
+      end
+      return _entries
+    end
+
+    # Flush changes made to
+    # hosts file
+    def flush()
+      new_hosts_file_content = ''
+      longest_dest_name = 0
+
+      @entries.each do |dest, obj|
+        next unless (obj.has_key?("hostnames"))
+        if (dest.length > longest_dest_name)
+          longest_dest_name = dest.length
+        end
+      end
+
+      longest_dest_name += 1
+
+      @entries.each do |dest, obj|
+        if (obj.has_key?('comment') && !obj.has_key?('hostnames'))
+          new_hosts_file_content << obj['comment'] << "\n"
+        elsif (obj.has_key?('newline'))
+          new_hosts_file_content << "\n"
+        else
+          new_hosts_file_content << ("%-#{longest_dest_name}.#{longest_dest_name}s" % dest)
+          new_hosts_file_content << (obj['hostnames'] * ' ')
+          
+          if (obj['comment'].length > 0)
+            comment = obj['comment']
+            # If it for some reason is not formated
+            # as a comment
+            unless (/^[\s\t]*?#/ =~ comment)
+              comment = '#' + comment
+            end
+            new_hosts_file_content += ("\s" + comment)
+          end
+          
+          new_hosts_file_content << "\n"
+        end
+      end
+
+      puts
+      puts "new content of hosts file:"
+      puts new_hosts_file_content
+      puts
+
+      File.open(@hosts_file_path, "w+").write(new_hosts_file_content)
+    end
+  end
+
+  class InvalidHostsFileException < Exception
+  end
+end

data/lib/Hosts/Lib/Core/SubCommand.rb

@@ -0,0 +1,61 @@
+module Hosts::Lib::Core
+  class SubCommand
+    attr_reader :name
+    attr_reader :description
+    attr_reader :options
+
+    # If true, print help message on empty args
+    attr_reader :assume_help
+
+    def initialize(name, description, options, assume_help = true, &block)
+      @name        = name
+      @description = description
+      @options     = options
+      @block       = block
+      @assume_help  = assume_help
+    end
+
+    def run(args)
+      begin
+        # If no option spesified, assume --help
+        # The underscore is a hack, see rescue block
+        if (assume_help)
+          fail Slop::UnknownOption.new "Unknown option --help", "--help" if (args.length == 0)
+        end
+
+        @options.parse(args); # Dryrun to check for argument errors
+        @block.call(@options, args)
+      rescue Slop::UnknownOption => e
+        # Hack to get around the lack of e.getUnknownOption()
+        # TODO Fix once avaiable
+        if (e.flag == '--help')
+          print_help_message
+        else
+          puts "#{e.message}. Try 'hosts #{@name} help'"
+        end
+      end
+    end
+
+    def self.is_flag(str)
+      return str.start_with?("--") || (str.start_with?("-") && str.length == 2)
+    end
+
+    def print_help_message
+      puts 'hosts ' + @name
+      if (@description != '')
+        puts "\tDescription:"
+        puts "\t" + @description
+      end
+      if @options.options.length > 0
+        puts
+        puts "\tArguments:"
+        @options.each do |a|
+          print "\t" + '%-16.16s' % (a.flags * ', ')
+          print "\t"
+          print a.desc + "\n"
+        end
+      end
+      puts
+    end
+  end
+end

data/lib/Hosts/Lib/autoload.rb

@@ -0,0 +1,20 @@
+require 'slop'
+
+module Hosts
+  LIB_PATH = File.dirname(File.dirname(File.expand_path("../", __FILE__)))
+end
+
+module Hosts::Lib end
+
+module Hosts::Lib::Core
+  autoload :HostsFile, File.dirname(__FILE__) + "/Core/HostsFile.rb"
+  autoload :SubCommand, File.dirname(__FILE__) + "/Core/SubCommand.rb"
+end
+
+module Hosts::Lib::Commands
+  autoload :Add, File.dirname(__FILE__) + "/Commands/Add.rb"
+  autoload :Rm, File.dirname(__FILE__) + "/Commands/Rm.rb"
+  autoload :List, File.dirname(__FILE__) + "/Commands/List.rb"
+  autoload :Version, File.dirname(__FILE__) + "/Commands/Version.rb"
+  autoload :Help, File.dirname(__FILE__) + "/Commands/Help.rb"
+end

data/lib/hosts.rb

@@ -0,0 +1,37 @@
+require_relative 'Hosts/Lib/autoload.rb'
+
+module Hosts
+  VERSION = "0.1.0"
+
+  def self.main
+    @sub_commands = {}
+    @sub_commands['add']  = Hosts::Lib::Commands::Add
+    @sub_commands['help'] = Hosts::Lib::Commands::Help
+    @sub_commands['list']  = Hosts::Lib::Commands::List
+    @sub_commands['rm']  = Hosts::Lib::Commands::Rm
+    @sub_commands['version']  = Hosts::Lib::Commands::Version
+
+    if ARGV[0] == nil
+      Hosts::Lib::Commands::Help.run([]);
+    elsif @sub_commands[ARGV[0]].nil?
+      puts "'#{ARGV[0]}' is not a sub command. See 'hosts help'"
+    else
+      sub_cmd_obj = @sub_commands[ARGV[0].downcase]
+      ARGV.shift; # Remove subcommand from ARGV, rest is options
+      sub_cmd_obj.run(ARGV)
+    end
+  end
+
+  def self.dir
+    File.dirname(File.expand_path(__FILE__))
+  end
+
+  def self.hosts_file
+    return "/etc/hosts"
+  end
+
+  #attr_reader :sub_commands
+  def self.sub_commands
+    return @sub_commands
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: hosts-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sigurd Berg Svela
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-20 00:00:00.000000000 Z
+dependencies: []
+description: An easy CLI to edit the hosts file on unix systems
+email: sigurdbergsvela@gmail.com
+executables:
+- hosts
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/Hosts/Lib/Commands/Add.rb
+- lib/Hosts/Lib/Commands/Help.rb
+- lib/Hosts/Lib/Commands/List.rb
+- lib/Hosts/Lib/Commands/Rm.rb
+- lib/Hosts/Lib/Commands/Version.rb
+- lib/Hosts/Lib/Core/HostsFile.rb
+- lib/Hosts/Lib/Core/SubCommand.rb
+- lib/Hosts/Lib/autoload.rb
+- lib/hosts.rb
+- bin/hosts
+homepage: https://github.com/sigurdsvela/hosts
+licenses:
+- licenses
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Edit host file on unix system
+test_files: []