fixlr-browser_stakeout 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathan Fixler
+
+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.rdoc

@@ -0,0 +1,21 @@
+= browser_stakeout
+
+Like RStakeout, but for watching static web content in multiple web browsers.
+
+Watch a set of files and open them in Safari and/or Firefox if they change. 
+The files should probably be plain HTML files, but I'm not the boss of you.
+Refreshes index.htm or index.html by default (if they exist)
+
+Inspired by AutoTest and RStakeout.
+http://nubyonrails.com/articles/automation-with-rstakeout
+
+=== Example
+		
+* refresh both (since safari is already enabled by default)
+		cd /to/your/project
+		browser_stakeout --firefox file.html
+
+
+== Copyright
+
+Copyright (c) 2009 Nathan Fixler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "browser_stakeout"
+    gem.summary = %Q{Like RStakeout, but for watching static web content in multiple web browsers.}
+    gem.email = "nathan@fixler.org"
+    gem.homepage = "http://github.com/fixlr/browser_stakeout"
+    gem.authors = ["Nathan Fixler"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "browser_stakeout #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 1

data/bin/browser_stakeout

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby -w
+# require 'rubygems'
+require 'optparse'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'browser_stakeout'
+
+BrowserStakeout::Application.run!(*ARGV)

data/browser_stakeout.gemspec

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{browser_stakeout}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Fixler"]
+  s.date = %q{2009-05-13}
+  s.default_executable = %q{browser_stakeout}
+  s.email = %q{nathan@fixler.org}
+  s.executables = ["browser_stakeout"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/browser_stakeout",
+     "browser_stakeout.gemspec",
+     "lib/browser_stakeout.rb",
+     "lib/browser_stakeout/application.rb",
+     "lib/browser_stakeout/browsers/firefox.rb",
+     "lib/browser_stakeout/browsers/safari.rb",
+     "lib/browser_stakeout/options.rb",
+     "test/application_test.rb",
+     "test/browser_stakeout_test.rb",
+     "test/firefox_test.rb",
+     "test/options_test.rb",
+     "test/safari_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/fixlr/browser_stakeout}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Like RStakeout, but for watching static web content in multiple web browsers.}
+  s.test_files = [
+    "test/application_test.rb",
+     "test/browser_stakeout_test.rb",
+     "test/firefox_test.rb",
+     "test/options_test.rb",
+     "test/safari_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/browser_stakeout.rb

@@ -0,0 +1,8 @@
+require 'ostruct'
+require 'browser_stakeout/application'
+require 'browser_stakeout/options'
+require 'browser_stakeout/browsers/safari'
+require 'browser_stakeout/browsers/firefox'
+
+class BrowserStakeout
+end

data/lib/browser_stakeout/application.rb

@@ -0,0 +1,64 @@
+class BrowserStakeout
+  class Application
+    class << self
+      def run!(*arguments)
+        options = BrowserStakeout::Options.new(arguments)
+        
+        if options[:invalid_argument]
+          $stderr.puts "Invalid argument: #{options[:invalid_argument]}"
+          options[:show_help] = true
+        end
+
+        if options[:show_help]
+          $stderr.puts options.opts
+          return 1
+        end
+        
+        unless options.files.size >= 1
+          $stderr.puts "broken"
+          $stderr.puts options.opts
+          return 1
+        end
+
+        files = build_mtimes_hash(options.files)
+
+        trap('INT') do
+          puts "\nIt's quittin time..."
+          exit
+        end
+
+        # Check to see if the file being refreshed is on the files list.
+        index_file = options.find_index(files)
+
+        puts %{#{File.basename($0)} is reporting for duty! 
+        Currently watching #{files.collect {|k,v| File.basename(k)}.join(', ')}\n\n}
+
+        loop do
+          sleep 1
+        
+          changed_file, last_changed = files.find do |file, last_changed|
+            File.mtime(file) > last_changed
+          end
+        
+          if changed_file
+            files[changed_file] = File.mtime(changed_file)
+            puts "#{Time.now} => #{File.basename(changed_file)} changed"
+            options.browsers.each do |b|
+              system b.refresh(index_file||changed_file)
+            end
+          end
+        end
+      end
+
+      def build_mtimes_hash(arguments)
+        files = {}
+        arguments.each do |a|
+          Dir[a].each do |file|
+            files[file] = File.mtime(file)
+          end
+        end
+        files
+      end
+    end
+  end
+end

data/lib/browser_stakeout/browsers/firefox.rb

@@ -0,0 +1,11 @@
+class BrowserStakeout
+  class Browsers
+    class Firefox
+      class << self
+        def refresh(filename)
+          "open -g -a Firefox.app #{filename}"
+        end
+      end
+    end
+  end
+end

data/lib/browser_stakeout/browsers/safari.rb

@@ -0,0 +1,11 @@
+class BrowserStakeout
+  class Browsers
+    class Safari
+      class << self
+        def refresh(filename)
+          "open -g -a Safari.app #{filename}"
+        end
+      end
+    end
+  end
+end

data/lib/browser_stakeout/options.rb

@@ -0,0 +1,54 @@
+class BrowserStakeout
+  class Options < Hash
+    attr_reader :opts, :orig_args, :browsers, :files
+    
+    def initialize(args)
+      super()
+      
+      @orig_args = args.clone
+      self[:safari]  = true
+      self[:firefox] = false
+      self[:index]   = "index\.htm[l]?"
+      
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename($0)} [options] files-to-watch"
+        
+        o.on("-i", "--[no-]index FILENAME", 
+                "Specify the file to refresh whenever changes are found") do |i|
+          self[:index] = i
+        end
+        
+        o.on("-s", "--[no-]safari", "Reload the page(s) in Safari") do |s|
+          self[:safari] = s
+        end
+          
+        o.on("-f", "--[no-]firefox", "Reload the page(s) in Firefox") do |f|
+          self[:firefox] = f
+        end
+          
+        o.on_tail("-h", "--help", "Show this message") do
+          self[:show_help] = true
+        end
+      end
+      
+      begin
+        @opts.parse!(args)
+        @files = args
+      rescue OptionParser::InvalidOption => e
+        self[:invalid_argument] = e.message
+      end
+      
+
+      # Decide which browsers need to be refreshed.
+      # TODO: How can this be extended to include other browsers easily?
+      @browsers = []
+      @browsers << BrowserStakeout::Browsers::Safari if self[:safari]
+      @browsers << BrowserStakeout::Browsers::Firefox if self[:firefox]
+      raise "Zero browsers? Come on. Is that really what you want to do?" if @browsers.length == 0
+    end
+    
+    def find_index(files)
+      files.keys.find {|f| f =~ /#{self[:index]}/}
+    end
+  end
+end

data/test/application_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class TestOptions < Test::Unit::TestCase
+  def run_application(*arguments)
+    original_stdout = $stdout
+    original_stderr = $stderr
+    
+    fake_stdout = StringIO.new
+    fake_stderr = StringIO.new
+    
+    $stdout = fake_stdout
+    $stderr = fake_stderr
+    
+    result = nil
+    begin
+      result = BrowserStakeout::Application.run!(*arguments)
+    ensure
+      $stdout = original_stdout
+      $stderr = original_stderr
+    end
+    
+    @stdout = fake_stdout.string
+    @stderr = fake_stderr.string
+    
+    result
+  end
+  
+  def self.should_exit_with_code(code)
+    should "exit with code #{code}" do
+      assert_equal code, @result
+    end
+  end
+  
+  context "called without any args" do
+    setup { @result = run_application }
+    
+    should_exit_with_code 1
+    
+    should 'display usage on stderr' do
+      assert_match 'Usage:', @stderr
+    end
+    
+    should 'not display anything on stdout' do
+      assert_equal '', @stdout.squeeze.strip
+    end
+  end
+
+  context "called with -h" do
+    setup { @result = run_application }
+
+    should_exit_with_code 1
+    
+    should 'display usage on stderr' do
+      assert_match 'Usage:', @stderr
+    end
+    
+    should 'not display anything on stdout' do
+      assert_equal '', @stdout.squeeze.strip
+    end
+  end
+      
+  context "called with --invalid-argument" do
+    setup do
+      assert_nothing_raised do
+        @result = run_application("--invalid-argument")
+      end
+    end
+    
+    should_exit_with_code 1
+    
+    should 'display invalid argument' do
+      assert_match '--invalid-argument', @stderr
+    end
+    
+    should 'display usage on stderr' do
+      assert_match 'Usage:', @stderr
+    end
+    
+    should 'not display anything on stdout' do
+      assert_equal '', @stdout.squeeze.strip
+    end
+  end
+end

data/test/browser_stakeout_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TestOptions < Test::Unit::TestCase
+  should "the BrowserStakeout class doesn't really do anything yet" do
+    true
+  end
+end

data/test/firefox_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestFirefoxBrowser < Test::Unit::TestCase
+
+  context "foo.txt" do
+    setup do
+      @browser = BrowserStakeout::Browsers::Firefox
+    end
+    
+    should "refresh foo.txt" do
+      assert_equal "open -g -a Firefox.app foo.txt", @browser.refresh("foo.txt")
+    end
+  end
+end

data/test/options_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class TestOptions < Test::Unit::TestCase
+
+  def setup_options(*arguments)
+    @options = BrowserStakeout::Options.new(arguments)
+  end
+  
+  def self.for_options(*options)
+    context options.join(' ') do
+      setup { setup_options *options }
+      yield
+    end
+  end
+
+  context "default options" do
+    setup { setup_options }
+
+    should 'refresh Safari' do
+      assert @options[:safari]
+    end
+
+    should 'not refresh Firefox' do
+      assert !@options[:firefox]
+    end
+
+    should 'try to refresh index.htm[l]? by default' do
+      assert_equal "index\.htm[l]?", @options[:index]
+    end
+    
+    should 'refresh using the osx open command by default' do
+      assert_equal 'open -g', @options[:command]
+    end
+  end
+  
+  context "default options with file list" do
+    setup { setup_options("index.html", "news.html") }
+    
+    should "not be invalid" do
+      assert_nil @options[:invalid_argument]
+    end
+    
+    should "not show help" do
+      assert_nil @options[:show_help]
+    end
+    
+    should "still have two unused options" do
+      assert_equal 2, @options.files.length
+      assert_equal ['index.html', 'news.html'], @options.files
+    end
+  end
+  
+  for_options '--firefox' do
+    should 'refresh Firefox' do
+      assert @options[:firefox]
+    end
+  end
+
+  for_options '--help' do
+    should 'show help' do
+      assert @options[:show_help]
+    end
+  end
+
+  for_options '-h' do
+    should 'show help' do
+      assert @options[:show_help]
+    end
+  end
+  
+  for_options '--invalid' do
+    should 'be an invalid argument' do
+      assert @options[:invalid_argument]
+    end
+  end
+  
+  new_index = 'foo.html'
+  for_options "--index", new_index do
+    should "try to refresh #{new_index}" do
+      assert_equal new_index, @options[:index]
+    end
+  end
+
+  new_index = 'foo.html'
+  for_options "-i", new_index do
+    should "try to refresh #{new_index}" do
+      assert_equal new_index, @options[:index]
+    end
+  end
+end

data/test/safari_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestSafariBrowser < Test::Unit::TestCase
+
+  context "foo.txt" do
+    setup do
+      @browser = BrowserStakeout::Browsers::Safari
+    end
+    
+    should "refresh foo.txt" do
+      assert_equal "open -g -a Safari.app foo.txt", @browser.refresh("foo.txt")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'browser_stakeout'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: fixlr-browser_stakeout
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nathan Fixler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-13 00:00:00 -07:00
+default_executable: browser_stakeout
+dependencies: []
+
+description: 
+email: nathan@fixler.org
+executables: 
+- browser_stakeout
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- bin/browser_stakeout
+- browser_stakeout.gemspec
+- lib/browser_stakeout.rb
+- lib/browser_stakeout/application.rb
+- lib/browser_stakeout/browsers/firefox.rb
+- lib/browser_stakeout/browsers/safari.rb
+- lib/browser_stakeout/options.rb
+- test/application_test.rb
+- test/browser_stakeout_test.rb
+- test/firefox_test.rb
+- test/options_test.rb
+- test/safari_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/fixlr/browser_stakeout
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Like RStakeout, but for watching static web content in multiple web browsers.
+test_files: 
+- test/application_test.rb
+- test/browser_stakeout_test.rb
+- test/firefox_test.rb
+- test/options_test.rb
+- test/safari_test.rb
+- test/test_helper.rb