roast 0.1.2 → 0.2.0

data/README.md

@@ -36,6 +36,9 @@ $ sudo roast add 10.0.1.1 something.dev
 # add an entry to the "testing" group
 $ sudo roast add testing 127.0.0.1 exampleapp.dev
 
+# add an entry to the "testing" group via another hostname (resolve the ip)
+$ sudo roast add testing example.org exampleapp.dev
+
 # disable all entries with the ip "10.0.1.1"
 $ sudo roast disable 10.0.1.1
 

data/lib/roast.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'optparse'
 require 'tempfile'
+require 'socket'
 
 require 'roast/cli/commands'
 require 'roast/cli'

data/lib/roast/cli/commands.rb

@@ -21,23 +21,30 @@ module Roast
           puts "`#{command}' is an unknown command, use --help to see available commands"
           exit
         end
+      rescue ArgumentError => e
+        puts e.message
+        exit 1
+      end
+
+      def confirm(message = 'Are you sure that you want to do that?')
+        puts "#{message} [\"yes\" or \"no\"]"
+        exit if $stdin.gets.chomp !~ /\Ay(?:es)?\Z/i
       end
 
       def add(*args)
         if args.length < 2
-          raise ArgumentError, "You must provide an ip address and a hostname to point it too"
+          raise ArgumentError, "You must provide an ip address and a hostname to point it to: `roast add 127.0.0.1 something.dev'"
         elsif args.length == 3
           group = args.shift
         else
-          group = 'base'
+          group = nil
         end
 
-        args.reverse! if args.last =~ Host::IP_PATTERN
-        ip_address, hostname = args
+        source, hostname = args
 
-        if @hosts_file.add(group, ip_address, hostname)
+        if @hosts_file.add(group, source, hostname)
           @hosts_file.write
-          puts "added host entry for `#{ip_address}  \033[4m#{hostname}\033[0m'"
+          puts "added host entry for `#{source}  \033[4m#{hostname}\033[0m'"
         end
       end
 
@@ -65,6 +72,7 @@ module Roast
 
       def delete(*args)
         entry   = args.first
+        confirm("Are you sure that you want to delete entries matching `#{entry}'?")
         results = @hosts_file.delete(entry)
         if results.empty?
           puts "no entries found matching `#{entry}'"
@@ -98,7 +106,7 @@ module Roast
 
       def delete_group(*args)
         group = args.first
-
+        confirm("Are you sure that you want to delete the group `#{group}'?")
         if @hosts_file.delete_group(group)
           @hosts_file.write
           puts "deleted group `#{group}'"
@@ -115,7 +123,9 @@ module Roast
           puts "there are no roast entries in `#{path}'\n"
         else
           entries = ''
-          groups.each { |group| entries << group.to_cli }
+          indent  = groups.map { |g| g.hosts.map { |h| h.hostname.size }.max }.max
+
+          groups.each { |group| entries << group.to_cli(indent) }
           puts entries.chomp
         end
       end

data/lib/roast/group.rb

@@ -54,9 +54,9 @@ module Roast
       deleted
     end
 
-    def to_cli
+    def to_cli(max_indent = nil)
       string = " - \033[4m#{name}\033[0m\n"
-      max    = hosts.map { |h| h.hostname.size }.max
+      max = max_indent || hosts.map { |h| h.hostname.size }.max
 
       hosts.each do |host|
         padding = ' ' * (max - host.hostname.size + 4)
@@ -65,7 +65,9 @@ module Roast
         else
           string << '      '
         end
-        string << "#{host.hostname}#{padding}#{host.ip_address}\033[0m\n"
+        string << "#{host.hostname}#{padding}#{host.ip_address}"
+        string << "  # #{host.alias}" if host.alias
+        string << "\033[0m\n"
       end
 
       string
@@ -78,7 +80,9 @@ module Roast
       hosts.each do |host|
         padding = ' ' * (max - host.ip_address.size + 4)
         section << '# ' if host.disabled?
-        section << "#{host.ip_address}#{padding}#{host.hostname}\n"
+        section << "#{host.ip_address}#{padding}#{host.hostname}"
+        section <<  "  # #{host.alias}" if host.alias
+        section << "\n"
       end
 
       section

data/lib/roast/host.rb

@@ -1,23 +1,35 @@
 module Roast
   class Host
-    IP_PATTERN       = /\A\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\z/
+    IP_PATTERN       = /\A([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}\z/
     HOST_PATTERN     = /\A[a-z0-9\-\.]+\z/
 
-    attr_reader :ip_address
-    attr_reader :hostname
+    attr_reader   :ip_address
+    attr_reader   :hostname
+    attr_reader   :state
+    attr_accessor :alias
 
-    def initialize(ip_address, hostname)
-      @ip_address = ip_address.chomp
+    def initialize(source, hostname)
+      if source !~ IP_PATTERN
+        @alias = source.chomp
+        resolve_source
+      else
+        @ip_address = source.chomp
+      end
       @hostname   = hostname.chomp.downcase
       @state      = 'enabled'
       validate!
     end
 
     def validate!
-      raise ArgumentError, "`#{ip_address}' is an invalid ip address" unless ip_address =~ IP_PATTERN
       raise ArgumentError, "`#{hostname}' is an invalid hostname" unless hostname =~ HOST_PATTERN
     end
 
+    def resolve_source
+      @ip_address = IPSocket.getaddress(@alias)
+    rescue SocketError
+      raise ArgumentError, "unable to determine the ip address of `#{@alias}'"
+    end
+
     def disable!
       @state = 'disabled'
     end

data/lib/roast/hosts_file.rb

@@ -1,7 +1,7 @@
 module Roast
   class HostsFile
     GROUP_PATTERN = /^## \[([\w\s-]+)\]$/
-    HOST_PATTERN  = /^#?\s*(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\s+([^\s]+)/
+    HOST_PATTERN  = /^#?\s*(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\s+([a-z0-9\.\-]+)\s*(?:#\s*(\S+))?$/
     DISABLED_PATTERN = /^# \d+/
 
     attr_reader :path
@@ -37,6 +37,7 @@ module Roast
             @groups[group.name] ||= group
           elsif group && host_match = line.match(HOST_PATTERN)
             host = Host.new(host_match[1], host_match[2])
+            host.alias = host_match[3]
             host.disable! if line =~ DISABLED_PATTERN
             group << host
           else
@@ -46,6 +47,9 @@ module Roast
       end
 
       self
+    rescue Errno::EACCES
+      puts "Unable to read hosts file: `#{@path}', you might need to `sudo roast'"
+      exit 1
     end
 
     def write(output_path = nil)
@@ -54,10 +58,14 @@ module Roast
 
       temp_file << static_lines.join.sub(/\n{3,}\z/, "\n\n")
       temp_file << groups.map { |g| g.to_hosts_file.chomp }.join("\n\n")
-
       File.chmod(0644, temp_file.path)
-      FileUtils.cp(path, path + '.roast.bak') if output_path.eql?(path)
-      FileUtils.mv(temp_file.path, output_path, :force => true)
+      begin
+        FileUtils.cp(path, path + '.roast.bak') if output_path.eql?(path)
+        FileUtils.mv(temp_file.path, output_path, :force => true)
+      rescue Errno::EACCES
+        puts "Unable to write to hosts file: `#{@path}', you might need to `sudo roast'"
+        exit 1
+      end
     ensure
       temp_file.close
       temp_file.unlink
@@ -71,9 +79,10 @@ module Roast
       groups.map { |g| g.delete_host(entry) }.flatten
     end
 
-    def add(group, ip_address, hostname)
+    def add(group, source, hostname)
+      group ||= 'base'
       @groups[group] ||= Group.new(group)
-      @groups[group] << Host.new(ip_address, hostname)
+      @groups[group] << Host.new(source, hostname)
     end
 
     def enable(entry)

data/lib/roast/version.rb

@@ -1,3 +1,3 @@
 module Roast
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/roast.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'minitest', '~> 3.0.0'
+  spec.add_development_dependency 'mocha', '~> 0.13.3'
   spec.add_development_dependency 'rake'
 end

data/test/files/one

@@ -10,7 +10,7 @@ fe80::1%lo0     localhost
 ## [base]
 127.0.0.1    local.dev
 10.0.1.2     something.dev
-127.0.0.1    example.org
+127.0.0.1    example.org  # whatever.org
 
 ## [foo]
 # 10.0.3.1    foo.bar

data/test/host_test.rb

@@ -2,10 +2,33 @@ require 'test_helper'
 
 describe Roast::Host do
 
-  it "validates the ip address" do
-    ['foo', 'example.com', '127.0.0.1.1', '1277.0.0.1'].each do |ip|
-      lambda { Roast::Host.new(ip, 'blah.dev') }.must_raise ArgumentError
-    end
+  it "initializes a Host" do
+    host = Roast::Host.new('127.0.0.1', 'blah.dev')
+    host.hostname.must_equal 'blah.dev'
+    host.ip_address.must_equal '127.0.0.1'
+    host.state.must_equal 'enabled'
+    host.must_be :enabled?
+  end
+
+  it "disables a host" do
+    host = Roast::Host.new('127.0.0.1', 'blah.dev')
+    host.state.must_equal 'enabled'
+    host.disable!
+    host.state.must_equal 'disabled'
+    host.must_be :disabled?
+  end
+
+  it "enables a host" do
+    host = Roast::Host.new('127.0.0.1', 'blah.dev')
+    host.disable!
+    host.must_be :disabled?
+    host.enable!
+    host.must_be :enabled?
+  end
+
+  it "attempts to resolve a source hostname if given" do
+    Roast::Host.any_instance.expects(:resolve_source)
+    Roast::Host.new('google.com', 'blah.dev')
   end
 
   it "validates the hostname" do

data/test/hosts_file_test.rb

@@ -15,10 +15,12 @@ describe Roast::HostsFile do
     hosts.groups.length.must_equal 3
     [
       [ '127.0.0.1', 'local.dev' ],
-      [ '10.0.1.2', 'something.dev' ]
+      [ '10.0.1.2', 'something.dev' ],
+      [ '127.0.0.1', 'example.org', 'whatever.org']
     ].each_with_index do |host, i|
-      hosts['base'].hosts[i].ip_address.must_equal host.first
-      hosts['base'].hosts[i].hostname.must_equal host.last
+      hosts['base'].hosts[i].ip_address.must_equal host[0]
+      hosts['base'].hosts[i].hostname.must_equal host[1]
+      hosts['base'].hosts[i].alias.must_equal host[2] if host[2]
     end
     [
       [ '10.0.20.1', 'staging.something.com' ],
@@ -48,7 +50,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -82,7 +84,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -118,7 +120,7 @@ describe Roast::HostsFile do
     ## [base]
     # 127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -151,7 +153,7 @@ describe Roast::HostsFile do
     ## [base]
     # 127.0.0.1    local.dev
     10.0.1.2     something.dev
-    # 127.0.0.1    example.org
+    # 127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -184,7 +186,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -217,7 +219,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -250,7 +252,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     10.0.3.1    foo.bar
@@ -283,7 +285,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -315,7 +317,7 @@ describe Roast::HostsFile do
 
     ## [base]
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -379,7 +381,7 @@ describe Roast::HostsFile do
     ## [base]
     127.0.0.1    local.dev
     10.0.1.2     something.dev
-    127.0.0.1    example.org
+    127.0.0.1    example.org  # whatever.org
 
     ## [foo]
     # 10.0.3.1    foo.bar
@@ -392,15 +394,14 @@ describe Roast::HostsFile do
     hosts.groups.length.must_equal 3
     hosts['base'] << Roast::Host.new('127.0.0.1', 'example.org')
     hosts.write(File.join(FILES_PATH, 'two.new'))
-    File.exist?(File.join(FILES_PATH, 'one.bak')).wont_equal true
+    File.exist?(File.join(FILES_PATH, 'one.roast.bak')).wont_equal true
   end
 
   it "creates a backup file if the output file is the same as the input file" do
     hosts = hosts_from_file('one')
     hosts.groups.length.must_equal 3
-    hosts['base'] << Roast::Host.new('127.0.0.1', 'example.org')
     hosts.write
-    File.exist?(File.join(FILES_PATH, 'one.bak')).must_equal true
+    File.exist?(File.join(FILES_PATH, 'one.roast.bak')).must_equal true
   end
 
   def hosts_from_file(file_name)

data/test/test_helper.rb

@@ -7,4 +7,6 @@ Bundler.setup
 require 'minitest/autorun'
 require 'minitest/pride'
 
+require 'mocha/setup'
+
 require 'roast'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roast
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement