├── .gitignore ├── bin └── localdev ├── localdev.gemspec ├── README.md ├── lib └── localdev.rb └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | /*.gem -------------------------------------------------------------------------------- /bin/localdev: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | # 3 | # Localdev - Hosts file tool for local development 4 | # 5 | # Copyright 2011 by Mark Jaquith 6 | # 7 | # This program is free software; you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation; either version 2 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program; if not, write to the Free Software 19 | # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 20 | 21 | require 'localdev.rb' 22 | Localdev.new 23 | -------------------------------------------------------------------------------- /localdev.gemspec: -------------------------------------------------------------------------------- 1 | # -*- encoding: utf-8 -*- 2 | lib = File.expand_path('../lib/', __FILE__) 3 | $:.unshift lib unless $:.include?(lib) 4 | 5 | require 'localdev.rb' 6 | 7 | Gem::Specification.new do |s| 8 | s.name = "localdev" 9 | s.version = Localdev::VERSION 10 | s.platform = Gem::Platform::RUBY 11 | s.authors = ["Mark Jaquith"] 12 | s.email = ["mark@jaquith.me"] 13 | s.homepage = "http://github.com/markjaquith/Localdev" 14 | s.summary = %q{Add locally hosted domains to your hosts file, and disable/enable their use} 15 | s.description = %q{Localdev manages part of your hosts file and lets you specify domains to host locally. You can quickly enable or disable local hosting of those domains.} 16 | s.has_rdoc = false 17 | 18 | # s.required_rubygems_version = ">= 1.3.6" 19 | # s.rubyforge_project = "localdev" 20 | 21 | s.files = `git ls-files`.split("\n") 22 | # s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") 23 | s.executables = %w(localdev) 24 | s.require_paths = ["lib"] 25 | end 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Localdev 2 | 3 | Localdev is a Ruby command line script to register domains that you sometimes use for local development, and to quickly enable or disable local development for those domains. Only expected to work on OS X. Requires sudo access, as it is manipulating your hosts file. 4 | 5 | Available commands: 6 | 7 | * `localdev list` — lists the localdev domains 8 | * `localdev add {domain}` — adds the specified domain (pointing to 127.0.0.1) 9 | * `localdev add {domain} {ip}` — adds the specified domain (pointing to the IP you specified) 10 | * `localdev remove {domain}` — removes the specified domain 11 | * `localdev on` — enables local development 12 | * `localdev off` — disables local development 13 | * `localdev status` — shows the current status 14 | 15 | Note: if local development is on, `add` and `remove` commands will immediately update the hosts file and trigger a DNS flush. 16 | 17 | Tip: To avoid being prompted by `sudo` for your password, you can add a line like this to your `/etc/sudoers` file (replace `markjaquith` with your user name): 18 | 19 | ``` 20 | markjaquith ALL = NOPASSWD: /usr/bin/localdev 21 | ``` 22 | 23 | ## Installation 24 | 25 | To install Localdev, use RubyGems: 26 | 27 | ```bash 28 | sudo gem install localdev 29 | ``` 30 | 31 | ## Notes 32 | 33 | Your list of local development domains is kept in `/etc/hosts-localdev` as a YAML file. 34 | 35 | ## License & Copyright 36 | 37 | Localdev is Copyright Mark Jaquith 2011–2015, and is offered under the terms of the GNU General Public License, version 2, or any later version. -------------------------------------------------------------------------------- /lib/localdev.rb: -------------------------------------------------------------------------------- 1 | # 2 | # Localdev - Hosts file tool for local development 3 | # 4 | # Copyright 2011-2015 by Mark Jaquith 5 | # 6 | # This program is free software; you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation; either version 2 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program; if not, write to the Free Software 18 | # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 19 | 20 | require 'digest/md5' 21 | require 'yaml' 22 | 23 | class Localdev 24 | VERSION = '0.4.0' 25 | 26 | def initialize 27 | @debugMode = false 28 | @localdev = '/etc/hosts-localdev' 29 | @hosts = '/etc/hosts' 30 | @start = '#==LOCALDEV==#' 31 | @end = '#/==LOCALDEV==#' 32 | if !ARGV.first.nil? && [:on, :off, :add, :remove, :clear].include?( ARGV.first.to_sym ) 33 | require_sudo 34 | ensure_localdev_exists 35 | end 36 | command = ARGV.shift 37 | command = command.to_sym unless command.nil? 38 | object = ARGV.shift 39 | case command 40 | when :"--v", :"--version" 41 | info 42 | when :on, :off, :status, :list, :clear 43 | send command 44 | when :add, :remove 45 | require_sudo 46 | object.nil? && exit_error_message("'localdev #{command}' requires you to provide a domain") 47 | ensure_localdev_exists 48 | if ARGV.first.nil? 49 | send command, object 50 | else 51 | send command, object, ARGV.first 52 | end 53 | when nil, '--help', '-h' 54 | exit_message "Usage: localdev [on|off|status|list|clear]\n localdev [add|remove] domain [ip-address]" 55 | else 56 | exit_error_message "Invalid command" 57 | end 58 | end 59 | 60 | def require_sudo 61 | if ENV["USER"] != "root" 62 | exec("sudo #{ENV['_']} #{ARGV.join(' ')}") 63 | end 64 | end 65 | 66 | def info 67 | puts "Localdev #{self.class::VERSION}" 68 | end 69 | 70 | def debug message 71 | puts message if @debugMode 72 | end 73 | 74 | def exit_message message 75 | puts message 76 | exit 77 | end 78 | 79 | def exit_error_message message 80 | exit_message '[ERROR] ' + message 81 | end 82 | 83 | def flush_dns 84 | %x{dscacheutil -flushcache} 85 | end 86 | 87 | def ensure_localdev_exists 88 | File.open( @localdev, 'w' ) {|file| file.write('') } unless File.exists?( @localdev ) 89 | end 90 | 91 | def enable 92 | disable 93 | domains = [] 94 | File.open( @localdev, 'r' ) do |file| 95 | domains = YAML::load file.read 96 | domains = [] unless domains.respond_to? 'each' 97 | end 98 | File.open( @hosts, 'a' ) do |file| 99 | file.puts "\n" 100 | file.puts @start 101 | file.puts "# The md5 dummy entries are here so that things like MAMP Pro don't" 102 | file.puts "# discourtiously remove our entries" 103 | domains.each do |domain| 104 | # puts domain.inspect 105 | file.puts "#{domain['ip']} #{Digest::MD5.hexdigest(domain['domain'])}.#{domain['domain']} #{domain['domain']}" 106 | end 107 | file.puts @end 108 | end 109 | end 110 | 111 | def on 112 | enable 113 | flush_dns 114 | puts "Turning Localdev on" 115 | end 116 | 117 | def disable 118 | hosts_content = [] 119 | File.open( @hosts, 'r' ) do |file| 120 | started = false 121 | while line = file.gets 122 | started = true if line.include? @start 123 | hosts_content << line unless started 124 | started = false if line.include? @end 125 | end 126 | end 127 | while "\n" == hosts_content.last 128 | hosts_content.pop 129 | end 130 | File.open( @hosts, 'w' ) do |file| 131 | file.puts hosts_content 132 | end 133 | end 134 | 135 | def off 136 | disable 137 | flush_dns 138 | puts "Turning Localdev off" 139 | end 140 | 141 | def update_localdev 142 | domains = [] 143 | File.open( @localdev, 'r' ) do |file| 144 | domains = YAML::load file.read 145 | domains = [] unless domains.respond_to? 'each' 146 | debug domains.inspect 147 | yield domains 148 | debug domains.inspect 149 | end 150 | File.open( @localdev, 'w' ) do |file| 151 | file.puts YAML::dump domains 152 | end 153 | end 154 | 155 | def add domain, ip='127.0.0.1' 156 | domain = { 157 | 'domain' => domain, 158 | 'ip' => ip 159 | } 160 | 161 | _remove domain['domain'] 162 | update_localdev {|domains| domains << domain } 163 | enable if :on == get_status 164 | puts "Added #{domain['domain']} => #{domain['ip']}" 165 | status 166 | end 167 | 168 | def remove domain 169 | _remove domain 170 | enable if :on == get_status 171 | puts "Removed #{domain}" 172 | status 173 | end 174 | 175 | def _remove domain 176 | update_localdev {|domains| domains = domains.delete_if{|item| item['domain'] == domain } } 177 | end 178 | 179 | def clear 180 | update_localdev {|domains| domains.clear } 181 | enable if :on == get_status 182 | puts "Removed all domains" 183 | status 184 | end 185 | 186 | def get_status 187 | status = :off 188 | return status unless File.readable? @hosts 189 | File.open( @hosts, 'r' ) do |file| 190 | while line = file.gets 191 | if line.include? @start 192 | status = :on 193 | break 194 | end 195 | end 196 | end 197 | return status 198 | end 199 | 200 | def list 201 | File.open( @localdev, 'r' ) do |file| 202 | domains = YAML::load file.read 203 | domains.each do |domain| 204 | puts "#{domain['domain']} => #{domain['ip']}" 205 | end 206 | end 207 | end 208 | 209 | def status 210 | puts "Localdev is #{get_status}" 211 | end 212 | 213 | end 214 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA 6 | 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | Preamble 11 | 12 | The licenses for most software are designed to take away your 13 | freedom to share and change it. By contrast, the GNU General Public 14 | License is intended to guarantee your freedom to share and change free 15 | software--to make sure the software is free for all its users. This 16 | General Public License applies to most of the Free Software 17 | Foundation's software and to any other program whose authors commit to 18 | using it. (Some other Free Software Foundation software is covered by 19 | the GNU Library General Public License instead.) You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | this service if you wish), that you receive source code or can get it 26 | if you want it, that you can change the software or use pieces of it 27 | in new free programs; and that you know you can do these things. 28 | 29 | To protect your rights, we need to make restrictions that forbid 30 | anyone to deny you these rights or to ask you to surrender the rights. 31 | These restrictions translate to certain responsibilities for you if you 32 | distribute copies of the software, or if you modify it. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must give the recipients all the rights that 36 | you have. You must make sure that they, too, receive or can get the 37 | source code. And you must show them these terms so they know their 38 | rights. 39 | 40 | We protect your rights with two steps: (1) copyright the software, and 41 | (2) offer you this license which gives you legal permission to copy, 42 | distribute and/or modify the software. 43 | 44 | Also, for each author's protection and ours, we want to make certain 45 | that everyone understands that there is no warranty for this free 46 | software. If the software is modified by someone else and passed on, we 47 | want its recipients to know that what they have is not the original, so 48 | that any problems introduced by others will not reflect on the original 49 | authors' reputations. 50 | 51 | Finally, any free program is threatened constantly by software 52 | patents. We wish to avoid the danger that redistributors of a free 53 | program will individually obtain patent licenses, in effect making the 54 | program proprietary. To prevent this, we have made it clear that any 55 | patent must be licensed for everyone's free use or not licensed at all. 56 | 57 | The precise terms and conditions for copying, distribution and 58 | modification follow. 59 | 60 | GNU GENERAL PUBLIC LICENSE 61 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 62 | 63 | 0. This License applies to any program or other work which contains 64 | a notice placed by the copyright holder saying it may be distributed 65 | under the terms of this General Public License. The "Program", below, 66 | refers to any such program or work, and a "work based on the Program" 67 | means either the Program or any derivative work under copyright law: 68 | that is to say, a work containing the Program or a portion of it, 69 | either verbatim or with modifications and/or translated into another 70 | language. (Hereinafter, translation is included without limitation in 71 | the term "modification".) Each licensee is addressed as "you". 72 | 73 | Activities other than copying, distribution and modification are not 74 | covered by this License; they are outside its scope. The act of 75 | running the Program is not restricted, and the output from the Program 76 | is covered only if its contents constitute a work based on the 77 | Program (independent of having been made by running the Program). 78 | Whether that is true depends on what the Program does. 79 | 80 | 1. You may copy and distribute verbatim copies of the Program's 81 | source code as you receive it, in any medium, provided that you 82 | conspicuously and appropriately publish on each copy an appropriate 83 | copyright notice and disclaimer of warranty; keep intact all the 84 | notices that refer to this License and to the absence of any warranty; 85 | and give any other recipients of the Program a copy of this License 86 | along with the Program. 87 | 88 | You may charge a fee for the physical act of transferring a copy, and 89 | you may at your option offer warranty protection in exchange for a fee. 90 | 91 | 2. You may modify your copy or copies of the Program or any portion 92 | of it, thus forming a work based on the Program, and copy and 93 | distribute such modifications or work under the terms of Section 1 94 | above, provided that you also meet all of these conditions: 95 | 96 | a) You must cause the modified files to carry prominent notices 97 | stating that you changed the files and the date of any change. 98 | 99 | b) You must cause any work that you distribute or publish, that in 100 | whole or in part contains or is derived from the Program or any 101 | part thereof, to be licensed as a whole at no charge to all third 102 | parties under the terms of this License. 103 | 104 | c) If the modified program normally reads commands interactively 105 | when run, you must cause it, when started running for such 106 | interactive use in the most ordinary way, to print or display an 107 | announcement including an appropriate copyright notice and a 108 | notice that there is no warranty (or else, saying that you provide 109 | a warranty) and that users may redistribute the program under 110 | these conditions, and telling the user how to view a copy of this 111 | License. (Exception: if the Program itself is interactive but 112 | does not normally print such an announcement, your work based on 113 | the Program is not required to print an announcement.) 114 | 115 | These requirements apply to the modified work as a whole. If 116 | identifiable sections of that work are not derived from the Program, 117 | and can be reasonably considered independent and separate works in 118 | themselves, then this License, and its terms, do not apply to those 119 | sections when you distribute them as separate works. But when you 120 | distribute the same sections as part of a whole which is a work based 121 | on the Program, the distribution of the whole must be on the terms of 122 | this License, whose permissions for other licensees extend to the 123 | entire whole, and thus to each and every part regardless of who wrote it. 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------