buildhosts 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd39ee6d2cf4a7bda58a8b798a3b75909095fde6
-  data.tar.gz: f77559e91525d86add3987b6509034aac2b5a46f
+  metadata.gz: dcb1c66c0f2109dfc4acd09ef24ace9e30808a66
+  data.tar.gz: e49736b08f8a10917871e095f7fd7f30deee725b
 SHA512:
-  metadata.gz: 07d66f06173d5a1e5b408c7fe80ea4a925765a635c049f72b94fd57b6b24b95b0a0142857bc1cd150fcd7430b640c1c3a273b1cf381b9125835725fb093532e5
-  data.tar.gz: 34ccdf1682c6b1b1fd97a8f7fe48001f98ca95ee2d3abdb37d88c361eb2f46128b9e3e5d18a1c80387a9eddee62e3b95368c97b92e8f06aa066561c06f01d7e6
+  metadata.gz: 890455945cd7faea50fb2ae874789fdbbfc5521c47819784fb98b9f24f2206b1e642d90490c1db5552a443c16932ad881043e40b34ddfe0f0d6fd1f457a8e7cc
+  data.tar.gz: 9f193e3f2428ba0f55ba0eaed8945ad2ddf7c8c3c2c01a70d46a6c72dca5424407fe7f7410e19f4fb0eace8ccec693e76343aeb9a5ed923c43080e7dc247e70c

data/README.md

@@ -1,21 +1,20 @@
 # Buildhosts
 
-This script will:
+This is a script I wrote to write my `/etc/hosts` file for me.
 
-+ change your life
-+ make you smarter
-+ grant you three wishes, and
-+ do none of the above.
+Configuring all the entries was a hassle, especially when using
+[xip.io](http://xip.io). This script takes your local hostnames (and the
+various IP address you need to pass to xip.io) and creates all the necessary
+entries to access any of the hosts while passing any of the IPs to xip.io.
 
-But really, this is just a script I wrote to write my /etc/hosts file for me.
-Configuring all the entries was a hassle, especially when using [xip.io](http://xip.io).
-This script takes your local hostnames (and the various IP address you need to pass
-to xip.io) and create all the necessary entries to access any of the hosts while
-passing any of the IPs to xip.io.
+Oh, and there's really no point in using this script if you're not using xip.io.
 
 ### Manginx
 
-Also included in `manginx`, a script that helps with using xip.io with nginx.
+Also included is `manginx`, a script that keeps xip.io and nginx in harmony.
+More on that later.
+
+
 
 ## Installation
 
@@ -23,58 +22,56 @@ That's easy:
 
     $ gem install buildhosts
 
-You will want to *back up your current `hosts` file*, though.
+Boom.
+
 
 ## Usage
 
-To edit your config file, type
+Before you do anything, *back up your current `/etc/hosts` file!*
+
+##### To edit your config file, type
 
     $ buildhosts -e
 
+You should do that before doing anything else (except backing up your
+`/etc/hosts` file, do that first).
 
-You can add custom hosts by typing
+
+##### You can add custom hosts by typing
 
     $ buildhosts -c
 
 
-List your hosts with
+##### List your hosts with
 
     $ buildhosts -l
 
-
-Run manginx with
-
-    $ buildhosts --nginx
+Note: this does not list the IPs, only the hosts.
 
 
-Just running `buildhosts` will recompile your hosts file.
+##### Run manginx with
 
+    $ buildhosts --nginx
 
-About the IP Address Section
-----------------------------
 
-The IP section is for working with xip.io, a DNS server that makes testing local
-websites on mobile devices much simpler. You can read more about it [here](http://xip.io).
-If you don't want to work with xip.io, don't include the IP address section in your config file.
 
-Configuring the Script
-----------------------
+## Configuration
 
 If you run `buildhosts` with this `config` file:
 
-### sample-config:
+#### sample-config
 
     [hosts]
         foobar.local
         example.local
     [ips]
         192.168.1.1
-        192.168.0.1
         10.0.1.1
 
 it will produce this output:
 
-### /etc/hosts
+#### /etc/hosts
+
     ##
     # Host Database
     #
@@ -90,43 +87,46 @@ it will produce this output:
     127.0.0.1       example.local
     ::1             example.local.10.0.1.1.xip.io
     127.0.0.1       example.local.10.0.1.1.xip.io
-    ::1             example.local.192.168.0.1.xip.io
-    127.0.0.1       example.local.192.168.0.1.xip.io
     ::1             example.local.192.168.1.1.xip.io
     127.0.0.1       example.local.192.168.1.1.xip.io
     ::1             foobar.local
     127.0.0.1       foobar.local
     ::1             foobar.local.10.0.1.1.xip.io
     127.0.0.1       foobar.local.10.0.1.1.xip.io
-    ::1             foobar.local.192.168.0.1.xip.io
-    127.0.0.1       foobar.local.192.168.0.1.xip.io
     ::1             foobar.local.192.168.1.1.xip.io
     127.0.0.1       foobar.local.192.168.1.1.xip.io
 
-Simple enough? I thought so.
 
-Manginx
--------
 
-To run manginx, just do 
+## Manginx
+
+For each host you specified in the `config`, manginx will create a file that
+contains duplicate server_name directives for the host, but with all the
+necessary xip.io URLs appended. You just need to include that file in your
+`nginx.conf` (see below) and run
 
     $ buildhosts --nginx
 
+Note: make sure you have a `xip/` directory in the same directory as your
+`nginx.conf`.
+
+#### To include the file,
 
-As far as configuring goes, just make sure you have an `xip` directory in the same directory as your `nginx.conf`.
-Then just duplicate any server_name lines in your `nginx.conf` and alter them like so:
+just duplicate any server_name lines in your
+`nginx.conf` and modify them like this:
 
-### Before:
+##### Before:
     server_name foobar.local;
 
-### After:
+##### After:
     server_name foobar.local;
     include xip/foobar.local;
 
-## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+### Vim protip:
+
+From a server_name line (in normal mode):
+
+    yypRinclude xip/
+
+If you've got a lot of lines to do, make that a macro; you won't regret it.

data/lib/buildhosts.rb

@@ -7,7 +7,7 @@ module Buildhosts
         attr_reader :path
 
         def initialize
-            @path = File.expand_path('../../', __FILE__)
+            @path = File.expand_path('../../files/', __FILE__)
             @files = Hash.new
             ['config', 'custom', 'header', 'newhosts', 'temp'].each do |f|
                 if (File.exist?(File.expand_path("~/.buildhosts/#{f}")))

data/lib/buildhosts/Manginx.rb

@@ -22,6 +22,7 @@ module Buildhosts
                 puts 'What\'s the point?'
                 exit
             end
+            system('mkdir -p /usr/local/etc/nginx/xip')
             # Let's find out what nginx is expecting from us...
             expected = Array.new
             n = File.open('/usr/local/etc/nginx/nginx.conf', 'r')
@@ -36,7 +37,7 @@ module Buildhosts
 
             # This is where the files will be stored.
             base_path = '/usr/local/etc/nginx/xip'
-            `rm #{base_path}/*`
+            `rm -f #{base_path}/*`
 
             # Le bread and buttere
             expected.each do |file|
@@ -51,7 +52,7 @@ module Buildhosts
 
             # Now we just reload nginx and apologize if something goes rotten.
             done 'Reloading nginx...'
-            if system('nginx -s reload')
+            if system('sudo nginx -s reload')
                 done
             else
                 puts "Oops!\nSomething went wrong... Sorry."

data/lib/buildhosts/version.rb

@@ -1,3 +1,3 @@
 module Buildhosts
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buildhosts
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,15 +55,13 @@ files:
 - Rakefile
 - bin/buildhosts
 - buildhosts.gemspec
-- config
-- custom
-- header
+- files/config
+- files/custom
+- files/header
 - lib/buildhosts.rb
 - lib/buildhosts/ConfigParser.rb
 - lib/buildhosts/Manginx.rb
 - lib/buildhosts/version.rb
-- lib/old.buildhosts.rb
-- sample-config
 homepage: ''
 licenses:
 - MIT

data/lib/old.buildhosts.rb

@@ -1,22 +0,0 @@
-require './ConfigParser.rb'
-
-# Prefixy strings
-ipv6 = '::1             '
-home = '127.0.0.1       '
-
-# Grab that parser and parse
-p = ConfigParser.new
-conf = p.parse 'config'
-
-# Write the lines to a "newhosts" file
-out = File.open('newhosts', 'w+')
-conf['hosts'].each do |host|
-    out.write "#{ipv6}#{host}\n"
-    out.write "#{home}#{host}\n"
-    conf['ips'].each do |ip|
-        out.write "#{ipv6}#{host}.#{ip}.xip.io\n"
-        out.write "#{home}#{host}.#{ip}.xip.io\n"
-    end
-end
-out.close
-

data/sample-config

@@ -1,15 +0,0 @@
-# Hostnames go here, one per line
-foobar.local
-example.local
-
-# Don't delete the ampersand
-# (unless you also delete
-# everything below it).
-&
-
-# IP addresses for xip.io.
-# You can just leave this blank
-# if you're not using it.
-192.168.1.1
-192.168.0.1
-10.0.1.1