work 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in work.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    work (0.1.0)
+      sys-uname (>= 0.8.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.0)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sys-uname (0.8.5)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (>= 2.5.0)
+  work!
+  yard (>= 0.6.4)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tim Blair
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Work
+
+Anti-procrastination through `hosts` file hackery.
+
+
+## Installation
+
+    $ gem install work
+
+
+## Usage ##
+
+    $ work setup      # => sets up default domain list in ~/.work
+    $ work [start]    # => disables access to domain list
+    $ work stop       # => enables access to domain list
+
+There is also a `play` alias place which inverses the `work` commands:
+
+    $ play [start]    # => enables access to domain list
+    $ play stop       # => disables access to domain list
+
+You can modify your list of work-only domains in `~/.work`.  Just
+use the root domain (`www.` will be added automatically.)
+
+
+## Credits
+
+Ideas and motivation prompted by:
+
+* [get-shit-done](http://github.com/leftnode/get-shit-done)
+* Alex Payne: [My Get-Back-To-Work Hack](http://al3x.net/2009/09/14/my-get-back-to-work-hack.html)
+
+
+## Licensing and Attribution
+
+Copyright (c)2011 [Tim Blair](http://tim.bla.ir/).
+
+Work has been released under the MIT license as detailed in the
+LICENSE file that should be distributed with this library; the source code is
+[freely available](http://github.com/timblair/work).

data/Rakefile

@@ -0,0 +1,38 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+#
+# Rspec
+#
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => [:start, :spec, :stop]
+
+
+#
+# Yard
+#
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+
+#
+# Misc.
+#
+
+desc "Start an irb console with Work pre-loaded."
+task :console do
+  exec "irb -r spec/spec_helper"
+end
+task :c => :console

data/bin/play

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'work'
+
+# Due to access permissions (i.e. the hosts file isn't usually
+# writable to the current user, we need the ability to re-run
+# this process under the super user.
+def sudome
+  if ENV["USER"] != "root"
+    # `exec` replaces this process, so no need to `exit` as well.
+    exec("sudo #{$0} #{ARGV.join(' ')}")
+  end
+end
+
+# Find the location of the user's work preferences.
+dotfile = Work::DotFile.locate
+
+case ARGV.first
+# We need a list of domains to work with, which is stored in a
+# ~/.work hidden file.
+when 'setup'
+  dotfile = Work::DotFile.locate
+  if dotfile.exists?
+    puts "Work file already exists at #{dotfile.path}"
+  else
+    dotfile.write(Work::DEFAULT_DOMAINS) if !dotfile.exists?
+    puts "Default work domains added to #{dotfile.path}"
+  end
+
+# Not a setup command, so we'll need the `Teacher`
+else
+  # Warn the user if they've not set up a domains list
+  if dotfile.read.length == 0
+    puts "Domain list is empty.  Add work domains to #{dotfile.path}"
+    puts "or run `#{$0} setup` to populate with the default list."
+    exit
+  end
+
+  # If we can't write to the hosts file, re-run but with `sudo`.
+  begin
+    p = Work::Teacher.new(dotfile.read, ARGV[1], ARGV[2])
+  rescue Work::HostsFileNotWritable
+    sudome
+  end
+
+  # Decide if we're beginning or ending work.
+  cmd = File.basename($0)
+  action = ARGV.first || 'on'
+
+  if (cmd == 'play' && %{ start on begin }.include?(action)) ||
+     (cmd != 'play' && %{ stop off end }.include?(action))
+    puts "Out in to the playground, children."
+    p.play
+  else
+    puts "Bums on seats, please."
+    p.work
+  end
+
+  # Run the command to reload the machine's DNS cache.
+  p.recache!
+end

data/bin/work

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'work'
+
+# Due to access permissions (i.e. the hosts file isn't usually
+# writable to the current user, we need the ability to re-run
+# this process under the super user.
+def sudome
+  if ENV["USER"] != "root"
+    # `exec` replaces this process, so no need to `exit` as well.
+    exec("sudo #{$0} #{ARGV.join(' ')}")
+  end
+end
+
+# Find the location of the user's work preferences.
+dotfile = Work::DotFile.locate
+
+case ARGV.first
+# We need a list of domains to work with, which is stored in a
+# ~/.work hidden file.
+when 'setup'
+  dotfile = Work::DotFile.locate
+  if dotfile.exists?
+    puts "Work file already exists at #{dotfile.path}"
+  else
+    dotfile.write(Work::DEFAULT_DOMAINS) if !dotfile.exists?
+    puts "Default work domains added to #{dotfile.path}"
+  end
+
+# Not a setup command, so we'll need the `Teacher`
+else
+  # Warn the user if they've not set up a domains list
+  if dotfile.read.length == 0
+    puts "Domain list is empty.  Add work domains to #{dotfile.path}"
+    puts "or run `#{$0} setup` to populate with the default list."
+    exit
+  end
+
+  # If we can't write to the hosts file, re-run but with `sudo`.
+  begin
+    p = Work::Teacher.new(dotfile.read, ARGV[1], ARGV[2])
+  rescue Work::HostsFileNotWritable
+    sudome
+  end
+
+  # Decide if we're beginning or ending work.
+  cmd = File.basename($0)
+  action = ARGV.first || 'on'
+
+  if (cmd == 'play' && %{ start on begin }.include?(action)) ||
+     (cmd != 'play' && %{ stop off end }.include?(action))
+    puts "Out in to the playground, children."
+    p.play
+  else
+    puts "Bums on seats, please."
+    p.work
+  end
+
+  # Run the command to reload the machine's DNS cache.
+  p.recache!
+end

data/lib/work/dotfile.rb

@@ -0,0 +1,29 @@
+module Work
+  class DotFile
+
+    attr_accessor :path
+
+    def self.locate
+      @dotfile ||= self.new File.expand_path(File.join('~', '.work'))
+    end
+
+    def initialize(path)
+      @path = path
+    end
+
+    def exists?
+      File.exists? @path
+    end
+
+    def read
+      File.readlines(path).collect { |d| d.strip }.sort rescue []
+    end
+
+    def write(data)
+      File.open(path, 'w+') do |f|
+        f.write(data.is_a?(Array) ? data.join("\n") : data)
+      end
+    end
+
+  end
+end

data/lib/work/teacher.rb

@@ -0,0 +1,70 @@
+require 'digest/md5'
+require 'rubygems'
+require 'sys/uname'
+
+module Work
+  class Teacher
+
+    attr_accessor :path, :domains, :ip
+
+    def initialize(domains, path=nil, ip=nil)
+      @domains = domains
+      @path = path || "/etc/hosts"
+      @ip = ip || "127.0.0.1"
+      raise HostsFileNotWritable if !File.writable?(@path)
+    end
+
+    def separator
+      @separator ||= "#==#{self.class.name}/#{Digest::MD5.hexdigest(self.class.name + path)}"
+    end
+
+    def msg
+      "# Do not modify.  Controlled by Work: http://github.com/timblair/work"
+    end
+
+    def work
+      File.open(path, 'r+') do |f|
+        lines = f.read
+        if !lines.match /#{separator}/
+          self.class.overwrite_file(f) do
+            extra = domains.collect { |d| "#{ip}\t#{d}\twww.#{d}" }
+            lines << "\n\n#{separator}\n#{msg}\n#{extra.join("\n")}\n#{separator}"
+          end
+        end
+      end
+    end
+
+    def play
+      File.open(path, 'r+') do |f|
+        lines = f.read
+        if lines.match /#{separator}/
+          self.class.overwrite_file(f) do
+            lines.gsub /([\s\n]*#{separator}.*#{separator})/m, ""
+          end
+        end
+      end
+    end
+
+    def recache!
+      case Sys::Uname.sysname.downcase
+      when 'darwin'
+        system 'dscacheutil -flushcache'
+      when 'linux'
+        system '/etc/init.d/networking restart'
+      else
+        puts "Warning: unknown system type #{Sys::Uname.sysname.downcase}."
+        puts "You'll need to flush your DNS cache yourself..."
+      end
+    end
+
+    private
+
+    def self.overwrite_file(file, &block)
+      text = yield
+      file.rewind
+      file.write text
+      file.truncate text.length
+    end
+
+  end # Class Teacher
+end # Module Work

data/lib/work/version.rb

@@ -0,0 +1,3 @@
+module Work
+  VERSION = "0.1.0"
+end

data/lib/work.rb

@@ -0,0 +1,21 @@
+require 'work/version'
+require 'work/teacher'
+require 'work/dotfile'
+
+module Work
+
+  DEFAULT_DOMAINS = %w{
+    arstechnica.com boingboing.net cnet.com codinghorror.com crunchgear.com
+    daringfireball.net digg.com en.wikipedia.org engadget.com engadgetmobile.com
+    facebook.com feedly.com gawker.com gigaom.com gizmodo.com guardian.co.uk
+    hacker-newspaper.gilesb.com icombinator.net kottke.org lifehacker.com
+    macnn.com macrumors.com mashable.com metafilter.com news.google.com
+    news.ycombinator.com nytimes.com radar.oreilly.com readwriteweb.com
+    reddit.com techcrunch.com techmeme.com torrentfreak.com tuaw.com
+    tweetmeme.com venturebeat.com wired.com youtube.com zdnet.com zenhabits.net
+  }
+
+  class HostsFileNotWritable < StandardError; end
+  class DotFileNotWritable < StandardError; end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# add project-relative load paths
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# require stuff
+require 'work'
+require 'rspec'
+require 'rspec/autorun'
+

data/spec/work_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Work do
+
+  it "should do stuff" do
+    1.should == 1
+    nil.should be_nil
+  end
+
+end

data/work.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'work/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'work'
+  s.version     = Work::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Tim Blair']
+  s.email       = ['tim@bla.ir']
+  s.homepage    = 'https://github.com/timblair/work'
+  s.summary     = 'Anti-procrastination via hosts file manipulation.'
+  s.description = 'Anti-procrastination via hosts file manipulation.'
+
+  s.rubyforge_project = 'work'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'sys-uname', '>= 0.8.5'
+
+  s.add_development_dependency 'rspec', '>= 2.5.0'
+  s.add_development_dependency 'yard', '>= 0.6.4'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: work
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Blair
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sys-uname
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 8
+        - 5
+        version: 0.8.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 6
+        - 4
+        version: 0.6.4
+  type: :development
+  version_requirements: *id003
+description: Anti-procrastination via hosts file manipulation.
+email: 
+- tim@bla.ir
+executables: 
+- play
+- work
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/play
+- bin/work
+- lib/work.rb
+- lib/work/dotfile.rb
+- lib/work/teacher.rb
+- lib/work/version.rb
+- spec/spec_helper.rb
+- spec/work_spec.rb
+- work.gemspec
+homepage: https://github.com/timblair/work
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: work
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Anti-procrastination via hosts file manipulation.
+test_files: 
+- spec/spec_helper.rb
+- spec/work_spec.rb
+has_rdoc: