editserver 0.1.3 → 0.1.4

data/.gitignore

@@ -5,3 +5,5 @@ Gemfile.lock
 extra/editserver.scpt
 tags
 test/editserverrc
+coverage/
+profiling/

data/README.markdown

@@ -20,9 +20,10 @@ Everything works, and core tests are in place. More information forthcoming.
 
 ### TODO
 
- * Finish remaining tests
  * Improve applescript reliability
- * Clean up `Editserver::` namespace
+ * Avoid dynamic creation of Editor subclasses in `Editserver::` namespace
+   (a consequence of an earlier design decision)
+ * Special case: OS X's `Terminal.app` as `editor['terminal']`
 
 
 [1]: https://chrome.google.com/webstore/detail/ppoadiihggafnhokfkpphojggcdigllp

data/lib/editserver/command.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'fileutils'
 require 'yaml'
 require 'webrick/log'
 require 'rack'
@@ -24,6 +25,7 @@ class Editserver
         :AccessLog   => [], # rack does its own access logging, so keep this blank
         :pid         => nil,
         :config      => '',
+        :daemonize   => false,
         :environment => 'deployment'
       }
     end
@@ -38,36 +40,65 @@ class Editserver
           Options:
         ).gsub /^ +/, ''
 
-        opt.on '-p', '--port NUMBER', Integer, "default: #{rackopts[:Port]}" do |arg|
+        opt.on '-H', '--host HOST', "IP/Hostname to bind to; #{rackopts[:Host]} by default" do |arg|
+          @rackopts[:Host] = arg
+        end
+
+        opt.on '-p', '--port NUMBER', Integer, "Port to bind; #{rackopts[:Port]} by default" do |arg|
           @rackopts[:Port] = arg
         end
 
+        opt.on '-d', '--default EDITOR', 'Editor to launch at root path; May be one of:',
+               (Editserver.new(editoropts).editors.keys - ['default']).join(', ') do |arg|
+          @editoropts['default'] = arg
+        end
+
         opt.on '-t', '--terminal CMD', 'Terminal to launch for console editors' do |arg|
           @editoropts['terminal'] = arg
         end
 
-        opt.on '--rc PATH', "Path to rc file; #{@opts[:rcfile]} by default",
-               '(Also can be set by exporting EDITSERVERRC to environment)' do |arg|
-          @rcopts = nil # reset cached user opts
+        opt.on '-f', '--fork', 'Fork and daemonize; returns pid of daemon' do
+          @rackopts[:daemonize] = true
+          @rackopts[:pid]       = "/tmp/#{File.basename $0}/#{File.basename $0}.pid"
+        end
+
+        opt.on '-q', '--quiet', 'Produce no output' do
+          @opts[:quiet]           = true
+          @rackopts[:Logger]      = WEBrick::Log.new nil, WEBrick::BasicLog::FATAL - 1 # zero, essentially
+          @rackopts[:environment] = 'none'
+        end
+
+        opt.on '--rc PATH', "Path to rc file; #{@opts[:rcfile]} by default" do |arg|
+          @rcopts        = nil # reset cached user opts
           @opts[:rcfile] = File.expand_path arg
         end
 
         opt.on '--no-rc', 'Suppress reading of rc file' do
+          @rcopts          = nil
           @opts[:norcfile] = true
         end
+
+        # normally implicit, but must be explicit when having an option beginning with `h'
+        opt.on_tail '-h', '--help' do
+          puts opt; exit
+        end
       end
     end
 
+    def say str
+      puts str unless @opts[:quiet]
+    end
+
     def rcopts
       @rcopts ||= begin
         empty  = { 'rack' => {}, 'editor' => {} }
-        rcfile = File.expand_path ENV['EDITSERVERRC'] || @opts[:rcfile]
+        rcfile = File.expand_path @opts[:rcfile]
 
         if @opts[:norcfile]
           empty
         elsif File.exists? rcfile
           opts = YAML.load_file File.expand_path(rcfile)
-          opts           ||= {}
+          opts             = {} unless opts.is_a? Hash
           opts['rack']   ||= {}
           opts['editor'] ||= {}
           opts
@@ -103,13 +134,30 @@ class Editserver
 
     def run
       options.parse @args
+      $0 = 'editserver'
+
+      # Rack::Server issues shutdown on SIGINT only
+      trap :TERM do
+        trap :TERM, 'DEFAULT'
+        Process.kill :INT, $$
+      end
 
-      begin
-        $0 = 'editserver'
-        puts banner
-        server.start
-      ensure
-        puts fx("\nGoodbye!", [32,1])
+      if rackopts[:daemonize]
+        FileUtils.mkdir_p File.dirname(rackopts[:pid])
+        Process.wait fork { server.start }
+        sleep 0.1 until File.exists? rackopts[:pid] and File.read(rackopts[:pid]).to_i > 0
+
+        say host_and_port
+        say "Editserver PID: #{fx File.read(rackopts[:pid]), [36,1]}"
+      else
+        begin
+          say banner
+          server.start
+          say fx("\nGoodbye!", [32,1])
+        rescue StandardError => e
+          say fx(e.to_s, [31,1])
+          exit e.respond_to?(:errno) ? e.errno : 1
+        end
       end
     end
 
@@ -125,10 +173,15 @@ class Editserver
         \\ \\____\\ \\___,_\\ \\_\\ \\__\\/\\____/\\ \\____\\\\ \\_\\  \\ \\___/ \\ \\____\\\\ \\_\\
          \\/____/\\/__,_ /\\/_/\\/__/\\/___/  \\/____/ \\/_/   \\/__/   \\/____/ \\/_/
 
-        Listening on #{fx "#{rackopts[:Host]}:#{rackopts[:Port]}", [32,1]}\
+        #{host_and_port}
+        Press #{fx 'Ctrl-C', [36,1]} to exit.\
       ).gsub(/^ {8}/, '')
     end
 
+    def host_and_port
+      "Listening on #{fx "#{rackopts[:Host]}:#{rackopts[:Port]}", [32,1]}"
+    end
+
     def fx str, effects = []
       return str unless $stdout.tty?
       str.gsub /^(.*)$/, "\e[#{[effects].flatten.join ';'}m\\1\e[0m"

data/lib/editserver/version.rb

@@ -1,3 +1,3 @@
 class Editserver
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/editserver.rb

@@ -12,9 +12,8 @@ class Editserver
     # OS X editors
     'mate'   => 'mate -w',
     'mvim'   => 'mvim --nofork --servername EDITSERVER', # does not return when app must be launched
-    'kod'    => 'open -a Kod -W',                        # app must quit to release control
     'bbedit' => 'bbedit -w'                              # does not open file properly when app is launched
-  }
+  }.reject { |k,v| not File.executable? %x(which #{k.shellsplit[0]}).chomp }
 
   attr_reader :editors
 
@@ -78,8 +77,8 @@ class Editserver
     klass   = editor request.path_info
     Response.new(klass.new, request).call
   rescue RoutingError => e
-    warn e.to_s
     res = Rack::Response.new
+    res.write e.to_s
     res.status = 500
     res.finish
   end

data/test/editserver/command.test.rb

@@ -1,37 +1,57 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
+$:.unshift File.dirname(__FILE__)
 
+require 'tempfile'
+require 'yaml'
+require 'webrick/log'
+require 'rack/server'
 require 'editserver/command'
 require 'minitest/pride' if $stdout.tty?
 require 'minitest/autorun'
+require 'socket-test'
 
 describe Editserver::Command do
+  before { @cmd = Editserver::Command.new ['--no-rc'] }
+
   describe :initialize do
     it 'should take a single optional argument' do
       Editserver::Command.method(:initialize).arity.must_equal -1
     end
 
     it 'should set internal state' do
-      cmd = Editserver::Command.new ['--no-rc']
-      cmd.instance_variable_get(:@args).must_equal ['--no-rc']
-      cmd.instance_variable_get(:@opts).must_equal(:rcfile => '~/.editserverrc')
-      cmd.instance_variable_get(:@editoropts).must_equal('default' => nil, 'terminal' => nil)
-      cmd.instance_variable_get(:@rackopts).keys.sort_by(&:to_s).must_equal [
-        :Host, :Port, :Logger, :AccessLog, :pid, :config, :environment
-      ].sort_by &:to_s
+      @cmd.instance_variable_get(:@args).must_equal ['--no-rc']
+      @cmd.instance_variable_get(:@opts).must_equal(:rcfile => '~/.editserverrc')
+      @cmd.instance_variable_get(:@editoropts).must_equal('default' => nil, 'terminal' => nil)
+      @cmd.instance_variable_get(:@rackopts).keys.sort_by(&:to_s).must_equal [
+        :Host, :Port, :Logger, :AccessLog, :pid, :config, :daemonize, :environment
+      ].sort_by(&:to_s)
     end
   end
 
   describe :options do
-    before { @cmd = Editserver::Command.new ['--no-rc'] }
-
     it 'should return an OptionParser object' do
       @cmd.options.must_be_kind_of OptionParser
     end
 
     it 'should modify internal state when parsing a list of arguments' do
+      @cmd.options.parse %w[--host 0.0.0.0]
+      @cmd.instance_variable_get(:@rackopts)[:Host].must_equal '0.0.0.0'
+
       @cmd.options.parse %w[--port 1000]
       @cmd.instance_variable_get(:@rackopts)[:Port].must_equal 1000
 
+      @cmd.options.parse %w[--fork]
+      @cmd.instance_variable_get(:@rackopts)[:daemonize].must_equal true
+      @cmd.instance_variable_get(:@rackopts)[:pid].must_equal "/tmp/#{File.basename $0}/#{File.basename $0}.pid"
+
+      @cmd.options.parse %w[--quiet]
+      @cmd.instance_variable_get(:@opts)[:quiet].must_equal true
+      @cmd.instance_variable_get(:@rackopts)[:Logger].level.must_equal WEBrick::BasicLog::FATAL - 1
+      @cmd.instance_variable_get(:@rackopts)[:environment].must_equal 'none'
+
+      @cmd.options.parse %w[--default mate]
+      @cmd.instance_variable_get(:@editoropts)['default'].must_equal 'mate'
+
       @cmd.options.parse %w[--terminal xterm]
       @cmd.instance_variable_get(:@editoropts)['terminal'].must_equal 'xterm'
 
@@ -43,22 +63,185 @@ describe Editserver::Command do
     end
   end
 
-  #
-  # TODO: finish tests
-  #
+  describe :say do
+    it 'should write to $stdout unless --quiet option is specified' do
+      capture_io { @cmd.say 'AHHHHHH!' }.first.must_equal "AHHHHHH!\n"
+      @cmd.instance_variable_get(:@opts)[:quiet] = true
+      capture_io { @cmd.say 'AHHHHHH!' }.first.must_equal ''
+    end
+  end
 
   describe :rcopts do
-  end
+    before do
+      @rcfile = Tempfile.new 'editserverrc'
+      @cmd.instance_variable_get(:@opts)[:rcfile] = @rcfile.path
+    end
+
+    after { (@rcfile.close; @rcfile.unlink) if @rcfile.path }
+
+    it 'should load the YAML file specified at @opts[:rcfile]' do
+      opts = { 'editor' => { 'default' => 'emacs', 'terminal' => 'xterm' }, 'rack' => { 'port' => 1000 } }
+      @rcfile.write opts.to_yaml
+      @rcfile.rewind
+      @cmd.rcopts.must_equal opts
+    end
+
+    it 'should create any missing top level keys' do
+      @rcfile.write({ 'foo' => 'bar' }.to_yaml)
+      @rcfile.rewind
+      @cmd.rcopts.must_equal 'foo' => 'bar', 'rack' => {}, 'editor' => {}
+    end
+
+    it 'should return bare options if --no-rc is specified' do
+      opts = { 'editor' => { 'default' => 'emacs', 'terminal' => 'xterm' }, 'rack' => { 'port' => 1000 } }
+      @rcfile.write opts.to_yaml
+      @rcfile.rewind
+      @cmd.instance_variable_get(:@opts)[:norcfile] = true
+      @cmd.rcopts.must_equal 'rack' => {}, 'editor' => {}
+    end
+
+    it 'should return bare options if rcfile does not exist' do
+      opts = { 'editor' => { 'default' => 'emacs', 'terminal' => 'xterm' }, 'rack' => { 'port' => 1000 } }
+      @rcfile.write opts.to_yaml
+      @rcfile.rewind
+      @rcfile.close
+      @rcfile.unlink
+      @cmd.rcopts.must_equal 'rack' => {}, 'editor' => {}
+    end
+  end # rcopts
 
   describe :rackopts do
+    it 'should return @rackopts masked with @rcopts' do
+      @cmd.instance_variable_get(:@opts)[:rcfile] = '/dev/null'
+      @cmd.rackopts[:Port].must_equal 9999
+      @cmd.rackopts[:Host].must_equal '127.0.0.1'
+      @cmd.instance_variable_get(:@rcopts).merge!('rack' => { 'port' => 65535, 'host' => '1.1.1.1' })
+      @cmd.rackopts[:Port].must_equal 65535
+      @cmd.rackopts[:Host].must_equal '1.1.1.1'
+    end
   end
 
   describe :editoropts do
+    it 'should return @editoropts masked with @rcopts' do
+      @cmd.instance_variable_get(:@opts)[:rcfile] = '/dev/null'
+      @cmd.editoropts['default'].must_equal nil
+      @cmd.editoropts['terminal'].must_equal nil
+      @cmd.instance_variable_get(:@rcopts).merge!('editor' => { 'default' => 'pony', 'terminal' => 'sparkles' })
+      @cmd.editoropts['default'].must_equal 'pony'
+      @cmd.editoropts['terminal'].must_equal 'sparkles'
+    end
   end
 
   describe :server do
+    it 'should return an instance of Rack::Server' do
+      @cmd.server.must_be_kind_of Rack::Server
+    end
+
+    it 'should pass rack options to new server instance' do
+      @cmd.rcopts['rack']['port'] = 4000
+      @cmd.server.options[:Port].must_equal 4000
+      @cmd.rcopts['rack']['pid'] = '/dev/null'
+      @cmd.server.options[:pid].must_equal '/dev/null'
+    end
+
+    it "should set the server's @app to an instance of Editserver" do
+      @cmd.server.app.must_be_kind_of Editserver
+    end
   end
 
   describe :run do
+    it 'should parse the arguments stored in @args' do
+      @cmd.instance_variable_set :@args, ['--help']
+
+      rd, wr = IO.pipe
+
+      pid = fork do
+        rd.close
+        $stdout.reopen wr
+        @cmd.run
+      end
+
+      wr.close
+      Process.wait2(pid).last.exitstatus.must_equal 0
+      rd.read.must_match /Usage:.*--help/m
+    end
+
+    it 'should start the server, and shutdown on SIGINT and SIGTERM' do
+      # thread, because we don't want to serially boot two servers
+      pool = []
+      [[:INT, 10000], [:TERM, 10001]].each do |sig, port|
+        pool << Thread.new do
+          cmd    = @cmd.dup
+          rd, wr = IO.pipe
+
+          cmd.instance_variable_get(:@rackopts)[:Port] = port
+
+          pid = fork do
+            rd.close
+            $stdout.reopen wr
+            cmd.run
+          end
+
+          wr.close
+
+          sleep 0.1 until SocketTest.open? cmd.rackopts[:Host], port
+
+          Process.kill sig, pid
+
+          # give the server some time to shutdown
+          tries = 0
+          until Process.wait pid, Process::WNOHANG
+            sleep 0.1
+            # but no more than 2 seconds
+            Process.kill :KILL, pid if (tries += 1) > 20
+          end
+
+          (tries <= 20).must_equal true
+          rd.read.must_match /Listening.*#{cmd.rackopts[:Host]}:#{port}/
+        end
+      end
+
+      pool.each &:join
+    end
+
+    it 'should daemonize and write pidfile in daemon mode' do
+      @cmd.options.parse ['--fork', '--port=10002']
+
+      begin
+        bgpid = fork do
+          $stdout.reopen '/dev/null' # we're not too interested in this output
+          @cmd.run
+        end
+
+        sleep 0.1 until SocketTest.open? @cmd.rackopts[:Host], @cmd.rackopts[:Port]
+        Process.wait bgpid
+
+        pidfile = @cmd.rackopts[:pid]
+        pidbuf  = File.read pidfile
+        pid     = pidbuf.to_i
+
+        pidbuf.must_match /\A\d+\z/       # does it look like a pid?
+        Process.kill(0, pid).must_equal 1 # is it really alive?
+      ensure
+        # make sure the sucker dies
+        Process.kill :INT, pid
+        tries = 0
+        loop do
+          begin
+            Process.kill 0, pid
+            sleep 0.1
+          rescue Errno::ESRCH
+            break
+          end
+          if (tries += 1) > 20
+            Process.kill :KILL, pid
+            break
+          end
+        end
+        (tries <= 20).must_equal true
+      end
+
+      File.exists?(@cmd.rackopts[:pid]).must_equal false
+    end
   end
 end

data/test/editserver/socket-test.rb

@@ -0,0 +1,16 @@
+require 'socket'
+
+module SocketTest
+  class << self
+    include Socket::Constants
+
+    def open? host, port
+      sock = Socket.new AF_INET, SOCK_STREAM, 0
+      addr = Socket.sockaddr_in port, host
+      sock.connect addr
+      true
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Sung Pae
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -06:00
+date: 2011-02-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,8 +86,7 @@ files:
 - test/editserver/command.test.rb
 - test/editserver/editor.test.rb
 - test/editserver/response.test.rb
-- test/editserver/terminal/emacs.test.rb
-- test/editserver/terminal/vim.test.rb
+- test/editserver/socket-test.rb
 - test/test-editor
 has_rdoc: true
 homepage: http://github.com/guns/editserver
@@ -126,6 +125,5 @@ test_files:
 - test/editserver/command.test.rb
 - test/editserver/editor.test.rb
 - test/editserver/response.test.rb
-- test/editserver/terminal/emacs.test.rb
-- test/editserver/terminal/vim.test.rb
+- test/editserver/socket-test.rb
 - test/test-editor

data/test/editserver/terminal/emacs.test.rb

@@ -1,5 +0,0 @@
-$:.unshift File.expand_path('../../../lib', __FILE__)
-
-require 'editserver/terminal/emacs'
-require 'minitest/pride' if $stdout.tty?
-require 'minitest/autorun'

data/test/editserver/terminal/vim.test.rb

@@ -1,5 +0,0 @@
-$:.unshift File.expand_path('../../../lib', __FILE__)
-
-require 'editserver/terminal/vim'
-require 'minitest/pride' if $stdout.tty?
-require 'minitest/autorun'