rrails 0.3.1 → 0.4.0

data/Changes.md

@@ -1,6 +1,18 @@
-v0.3.1				2012-10-13 18:08:39 +0900
+v0.4.0				2012-10-15 09:56:00 +0900
 ------------------------------------------------------------------------
- - FIX: PAGE_SIZE constants define constants outside RemoteRails::Server namespace.
+ - MOD: pty support. So you can use rails console/server from rrails. (thanks quark-zju)
+ - MOD: pry support. (thansk quark-zju)
+ - MOD: add --host option. (thanks quark-zju)
+ - MOD: Change UNIXDomainSocket to IO.pipe. (thanks quark-zju)
+
+v0.3.1				2012-10-13 18:22:08 +0900
+------------------------------------------------------------------------
+ - (tag: v0.3.1) Regenerate gemspec for version 0.3.1
+ - Version bump to 0.3.1
+ - update changes.
+ - it should not define constants outside RemoteRails::Server namespace.
+ - restyle again.
+ - use markdown style.
  - update doc.
 
 v0.3.0				2012-10-13 14:58:02 +0900

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2012 Keiji, Yoshimi
+Copyright (c) 2012 Wu Jun <quark@lihdd.net>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,80 @@
+# rrails
+
+Preload rails environment in Remote server to make rails/rake commands faster.
+
+## Requirements
+
+* non-Windows OS
+* Ruby 1.9.3
+
+## Usage
+
+Start server:
+
+    $ cd ~/rails_project
+    $ export RAILS_ENV=development # optionally
+    $ bundle exec rrails-server
+    
+Run rails/rake commands using rrails:
+
+    $ export RAILS_ENV=development # optionally
+    $ rrails -- rails generate model Yakiniku
+    $ rrails -- rake db:migrate
+    $ rrails -- rake routes
+    $ rrails -- rails server
+    $ rrails -- rails console
+    $ rrails -- pry                # start pry as rails console
+
+    # If you need an interactive console for non rails *console
+    # commands, you may want to add '--pty' option.
+    # This makes sure that interactive things (like line editing)
+    # work correctly, but it also redirect all STDERR to STDOUT
+    # and keys like ^C may not work correctly.
+    $ rrails --pty -- rails server # use debugger
+
+You may want to add following code to your shell rc file:
+
+    rrails-exec() {
+        if pgrep -f rrails-server >/dev/null && grep -q rrails Gemfile.lock &>/dev/null; then
+            rrails -- "$@"
+        else
+            command "$@"
+        fi
+    }
+    alias rails='rrails-exec rails'
+    alias rake='rrails-exec rake'
+
+## Description
+
+rails command is too slow. and rake command is too slow under rails environment.
+So, rrails can run rails/rake commands by preloaded daemon.
+
+rails-sh is very good solution for this issue. But
+
+* it can't run "rake -T"
+* it can't use zsh's histroy.
+
+So I wrote rrails.
+
+## See Also
+
+* guard-rrails: https://github.com/walf443/guard-rrails
+* rails-sh: https://github.com/jugyo/rails-sh
+
+## Contributing to rrails
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Keiji, Yoshimi. <br>
+Copyright (c) 2012 Wu Jun.
+
+See LICENSE.txt for further details.
+

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/rrails/client.rb

@@ -2,6 +2,8 @@ require 'socket'
 require 'rrails'
 require 'shellwords'
 require 'optparse'
+require 'io/console'
+
 module RemoteRails
   #
   # client for RemoteRails::Server.
@@ -9,17 +11,26 @@ module RemoteRails
   # @example
   #   client = RemoteRails::Client.new({
   #     :cmd => "rails generate model Sushi",
-  #     :rails_env => "development",
+  #     :port => 5656,
+  #     :host => 'localhost'
   #   })
   #   client.run
   #
   class Client
-    def self.new_with_options(argv)
-      options = {}
+    def self.opts_parser(options = {})
       opts = OptionParser.new
+      opts.banner = 'Usage: rrails [options] [[--] commands]'
+      opts.on('-h', '--help', 'This help.')      {|v| options[:help] = v }
+      opts.on('--host=s', 'RRails server hostname. Default value is "localhost".')      {|v| options[:host] = v }
       opts.on('-E', '--rails_env=s') {|v| options[:rails_env] = v }
-      opts.on('-p', '--port=i')      {|v| options[:port] = v }
-      opts.parse!(argv)
+      opts.on('-p', '--port=i', 'RRails server port. Default value is decided from RAILS_ENV.')      {|v| options[:port] = v }
+      opts.on('-t', '--[no-]pty', "Prepare a PTY. Default value is decided by commands.")      {|v| options[:pty] = v }
+      return opts
+    end
+
+    def self.new_with_options(argv)
+      options = {}
+      opts_parser(options).parse!(argv)
 
       cmd = Shellwords.join(argv)
       options[:cmd] = cmd == "" ? nil : cmd
@@ -27,25 +38,66 @@ module RemoteRails
     end
 
     def initialize(options={})
-      @cmd = options[:cmd] || "rails"
-      @rails_env = options[:rails_env] || 'development'
+      @cmd = options[:cmd] || ""
       @host = options[:host] || 'localhost'
+      @rails_env = options[:rails_env] || ENV['RAILS_ENV'] || 'development'
       @port = options[:port] || DEFAULT_PORT[@rails_env]
+      @use_pty = options[:pty]
+      if @use_pty.nil?
+        # decide use_pty from cmd
+        case @cmd
+        when /^rails (?:c(?:onsole)?|db(?:console)?)$/, 'pry'
+          @use_pty = true
+        end
+      end
     end
 
     def run
+      if @cmd.empty?
+        STDERR.puts Client.opts_parser
+        return
+      end
+
       sock = TCPSocket.open(@host, @port)
-      sock.puts(@cmd)
-      while line = sock.gets
-        if line =~ /^FINISHED\t(.+)/
-          $stdout.puts("\nfinished (#{$1}sec)")
-          return
-        elsif line =~ /^OUT\t(.+)$/
-          $stdout.puts($1)
-        elsif line =~ /^ERROR\t(.+)$/
-          $stderr.puts($1)
+      sock.puts("#{@use_pty ? 'P' : ' '}#@cmd")
+      running = true
+
+      begin
+        # input thread
+        thread = Thread.start do
+          while running do
+            begin
+              input = @use_pty ? STDIN.getch : STDIN.gets
+              sock.write(input)
+              sock.flush
+            rescue
+              running = false
+              sock.close unless sock.closed?
+            end
+          end
+        end
+
+        while running && line = sock.gets
+          case line.chomp
+          when /^EXIT\t(.+)$/
+            exit($1.to_i)
+          when /^OUT\t(.+)$/
+            STDOUT.write($1.split(',').map(&:to_i).pack('c*'))
+          when /^ERR\t(.+)$/
+            STDERR.write($1.split(',').map(&:to_i).pack('c*'))
+          end
         end
+
+      rescue EOFError
+        running = false
+      rescue Interrupt
+        running = false
+        exit 130
       end
+
+      STDERR.puts "\nERROR: RRails server disconnected"
+      exit -1
     end
+
   end
 end

data/lib/rrails/server.rb

@@ -4,6 +4,8 @@ require 'logger'
 require 'rake'
 require 'stringio'
 require 'shellwords'
+require 'pty'
+require 'benchmark'
 
 # FIXME: rails command require APP_PATH constants.
 APP_PATH = File.expand_path('./config/application')
@@ -18,7 +20,7 @@ module RemoteRails
     PAGE_SIZE = 4096
 
     def initialize(options={})
-      @rails_env = options[:rails_env] || "development"
+      @rails_env = options[:rails_env] || ENV['RAILS_ENV'] || "development"
       @app_path = File.expand_path('./config/application')
       # should not access to outside
       @host = 'localhost'
@@ -30,14 +32,14 @@ module RemoteRails
       self.boot_rails
       server = TCPServer.open(@host, @port)
       @logger.info("starting rrails server on #{@host}:#{@port}")
-      trap(:INT) do
-        @logger.info("SIGINT recieved. shutdown...")
-        exit
-      end
-      trap(:TERM) do
-        @logger.info("SIGTERM recieved. shutdown...")
-        exit
+
+      [:INT, :TERM].each do |sig|
+        trap(sig) do
+          @logger.info("SIG#{sig} recieved. shutdown...")
+          exit
+        end
       end
+
       trap(:HUP) do
         @logger.info("SIGHUP recieved. reload...")
         ActionDispatch::Callbacks.new(Proc.new {}).call({})
@@ -46,31 +48,29 @@ module RemoteRails
       Thread.abort_on_exception = true
       loop do
         Thread.start(server.accept) do |s|
-          childpids = []
           begin
-            while line = s.gets
-              line.chomp!
-              @logger.info("invoke: #{line}")
-              start = Time.now
-              self.dispatch(s, line) { |pid| childpids << pid }
-              finish = Time.now
-              s.puts("FINISHED\t#{ finish - start }")
-              @logger.info("finished: #{line}")
+            line = s.gets.chomp
+            pty, line = (line[0] == 'P'), line[1..-1]
+            @logger.info("invoke: #{line} (pty=#{pty})")
+            status = nil
+            time = Benchmark.realtime do
+              status = dispatch(s, line, pty)
             end
-          rescue Errno::EPIPE => e
-            Process.kill 'TERM', *childpids unless childpids.empty?
-            @logger.error("client disconnect: " + e.message)
+            exitcode = status ? status.exitstatus || (status.termsig + 128) : 0
+            s.puts("EXIT\t#{exitcode}")
+            @logger.info("finished: #{line} (#{time} seconds)")
+          rescue Errno::EPIPE
+            @logger.info("disconnected: #{line}")
           end
         end
       end
     end
 
     def boot_rails
-      @logger.info("prepare rails environment")
+      @logger.info("prepare rails environment (#{@rails_env})")
       ENV["RAILS_ENV"] = @rails_env
-      require File.expand_path('./config/boot')
-      require @app_path
-      Rails.application.require_environment!
+      require File.expand_path('./config/environment')
+
       unless Rails.application.config.cache_classes
         ActionDispatch::Reloader.cleanup!
         ActionDispatch::Reloader.prepare!
@@ -78,38 +78,89 @@ module RemoteRails
       @logger.info("finished preparing rails environment")
     end
 
-    def dispatch(sock, line)
-      servsock_out, clisock_out = UNIXSocket.pair
-      servsock_err, clisock_err = UNIXSocket.pair
+    def dispatch(sock, line, pty=false)
+
+      if pty
+        m_out, c_out = PTY.open
+        c_in = c_err = c_out
+        m_fds = [m_out, c_out]
+        c_fds = [c_out]
+        clisocks = {in: m_out, out: m_out}
+      else
+        c_in, m_in = IO.pipe
+        m_out, c_out = IO.pipe
+        m_err, c_err = IO.pipe
+        m_fds = [m_in, m_out, m_err]
+        c_fds = [c_in, c_out, c_err]
+        clisocks = {in: m_in, out: m_out, err: m_err}
+      end
+
+      running = true
       pid = fork do
-        clisock_out.close
-        clisock_err.close
+        m_fds.map(&:close) if not pty
+        STDIN.reopen(c_in)
+        STDOUT.reopen(c_out)
+        STDERR.reopen(c_err)
         ActiveRecord::Base.establish_connection if defined?(ActiveRecord::Base)
-        STDOUT.reopen(servsock_out)
-        STDERR.reopen(servsock_err)
         execute *Shellwords.shellsplit(line)
       end
-      yield pid
-      servsock_out.close
-      servsock_err.close
-      buffers = {out: '', error: ''}
-      clisocks = {out: clisock_out, error: clisock_err}
+
+      c_fds.map(&:close) if not pty
+
+      # pump input. since it will block, make it in another thread
+      thread = Thread.start do
+        while running do
+          begin
+            input = sock.__send__(pty ? :getc : :gets)
+          rescue => ex
+            @logger.debug "input thread got #{ex}"
+            running = false
+          end
+          clisocks[:in].write(input) rescue nil
+        end
+      end
+
       loop do
-        [:out, :error].each do |channel|
+        [:out, :err].each do |channel|
+          next if not clisocks[channel]
           begin
-            buffers[channel] << clisocks[channel].read_nonblock(PAGE_SIZE)
-            while buffers[channel][/[\n\r]/]
-              line, buffers[channel] = buffers[channel].split(/[\n\r]/, 2)
-              sock.puts("#{channel.upcase}\t#{line}")
+            loop do
+              response = clisocks[channel].read_nonblock(PAGE_SIZE)
+              sock.puts("#{channel.upcase}\t#{response.bytes.to_a.join(',')}")
+              sock.flush
             end
           rescue Errno::EAGAIN, EOFError => ex
-            sleep 0.01
+            next
           end
         end
-        if Process.waitpid(pid, Process::WNOHANG)
-          return
+
+        if running
+          _, stat = Process.waitpid2(pid, Process::WNOHANG)
+          if stat
+            @logger.debug "child exits. #{stat}"
+            return stat
+          end
         end
+
+        # send heartbeat so that we got EPIPE immediately when client dies
+        sock.puts("PING")
+        sock.flush
+
+        # do not make CPU hot
+        sleep 0.1
       end
+    ensure
+      running = false
+      [*c_fds, *m_fds].each {|io| io.close unless io.closed?}
+      if pid
+        begin
+          Process.kill 0, pid
+          @logger.debug "killing pid #{pid}"
+          Process.kill 'TERM', pid rescue nil
+        rescue Errno::ESRCH
+        end
+      end
+      thread.kill if thread
     end
 
     def execute(cmd, *args)
@@ -120,9 +171,14 @@ module RemoteRails
         require 'rails/commands'
       when 'rake'
         ::Rake.application.run
+      when 'pry'
+        begin
+        ::Pry::CLI.parse_options
+        rescue NameError
+          STDERR.puts "if you want to use pry. you should add 'pry' to Gemfile."
+        end
       else
-        @logger.warn "#{cmd} not supported"
-        raise RuntimeError.new("#{cmd} is not supported in rrails.")
+        STDERR.puts "#{cmd} is not supported in RRails."
       end
     end
 

data/rrails.gemspec

@@ -5,17 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = "rrails"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Keiji, Yoshimi"]
-  s.date = "2012-10-13"
+  s.date = "2012-10-15"
   s.description = "remote run rails/rake command"
   s.email = "walf443@gmail.com"
   s.executables = ["rrails", "rrails-server"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/rrails",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-13 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -99,14 +99,14 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Changes.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/rrails
@@ -132,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2945796966926352412
+      hash: 3003535707070342098
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,51 +0,0 @@
-= rrails
-
-remote run rails/rake command.
-
-== Usage
-
-    # run server
-    $ cd ~/rails_project
-    $ bundle exec rrails-server
-    
-    # on another console.
-    $ rrails -- rails generate model Yakiniku
-    $ rrails -E test -- rake db:migrate
-
-== Description
-
-rails command is too slow. and rake command is too slow under rails environment.
-So, rrails can run rails/rake commands by preloaded daemon.
-
-rails-sh is very good solution for this issue. But
-* it can't run "rake -T"
-* it can't use zsh's histroy.
-
-So I wrote rrails.
-
-== Problem
-
-rrails can't work folloing commands:
-* rake (console|dbconsole): please use rails-sh
-* rake server
-
-== SEE ALSO
-
-* guard-rrails: https://github.com/walf443/guard-rrails
-* rails-sh: https://github.com/jugyo/rails-sh
-
-== Contributing to rrails
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Keiji, Yoshimi. See LICENSE.txt for
-further details.
-