rrails 0.4.0 → 1.0.0

data/Changes.md

@@ -1,3 +1,9 @@
+v1.0.0				2012-10-16 01:03:00 +0900
+ - XXX: It may have many imcopatible changes. "1.0.0" does not mean "stable version".
+ - MOD: support UNIXDomainSocket instead of TCPSocket. And UnixDomainSocket is default behaviour. So you can be easy to run rrails in many rails project. But you should run rrails clinet under your project's directory.(thanks quark-zju)
+ - MOD: "rails-server" command is obsolate. please use "rrails start" instead. see more about README.md. (thanks quark-zju)
+ - MOD: pry command is removed. please use pry hacks instead. https://gist.github.com/941174 (thanks quark-zju)
+
 v0.4.0				2012-10-15 09:56:00 +0900
 ------------------------------------------------------------------------
  - MOD: pty support. So you can use rails console/server from rrails. (thanks quark-zju)

data/README.md

@@ -1,41 +1,54 @@
 # rrails
 
-Preload rails environment in Remote server to make rails/rake commands faster.
+Preload rails environment to make rails/rake commands faster.
+
+## Why?
+
+Without rrails:
+
+    $ time ( rails generate >/dev/null )
+    ( rails generate > /dev/null; )  9.29s user 0.41s system 98% cpu 9.807 total
+    $ time ( rake routes >/dev/null )
+    ( rake routes > /dev/null; )  8.17s user 0.36s system 98% cpu 8.639 total
+
+With rrails:
+
+    $ source <(rrails shellrc)
+    $ rrails start                         # optionally
+
+    $ time ( rails generate >/dev/null )
+    ( rails generate > /dev/null; )  0.05s user 0.01s system 6% cpu 0.904 total
+    $ time ( rake routes >/dev/null )
+    ( rake routes > /dev/null; )  0.04s user 0.01s system 12% cpu 0.359 total
 
 ## Requirements
 
-* non-Windows OS
-* Ruby 1.9.3
+* POSIX Environment (Linux 2.6 - , Mac OSX Montain Lion). Windows is not supported.
+* Ruby 1.9.3p194 or above
 
 ## 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
+    $ export RAILS_ENV=development         # optionally
+    $ rrails rails generate model Yakiniku # first command, slow
+    $ rrails rails server                  # fast
+    $ rrails rails console                 # fast
+    $ rrails rake db:migrate               # fast
+    $ rrails rake routes                   # fast
+    $ rrails -- rake -T                    # '--' is needed. Otherwise '-T' will be parsed by rrails
+
+For more options, run:
+
+    $ rrails --help
 
-    # 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
+### Shell integration
 
-You may want to add following code to your shell rc file:
+You may want to add following lines to your shell rc file:
 
     rrails-exec() {
-        if pgrep -f rrails-server >/dev/null && grep -q rrails Gemfile.lock &>/dev/null; then
+        if [ -e config/environment.rb ]; then
+            # this might be slow, see below
             rrails -- "$@"
         else
             command "$@"
@@ -44,17 +57,50 @@ You may want to add following code to your shell rc file:
     alias rails='rrails-exec rails'
     alias rake='rrails-exec rake'
 
-## Description
+Directly running `rrails` (even without `bundle exec`) may be slow due to levels of dummy wrappers of Bundler.
+You can replace `rrails` with an absolute path `/(path_to_rrails_gem)/bin/rrails` to get rid of Bundle initializing code.
+This can save about 0.9 seconds.
+
+These lines (with correct absolute path) can be generated by `rrails shellrc`. So you can quickly update your shell rc file using:
+
+    rrails shellrc >> ~/.zshrc
 
-rails command is too slow. and rake command is too slow under rails environment.
-So, rrails can run rails/rake commands by preloaded daemon.
+### Bundler
 
-rails-sh is very good solution for this issue. But
+rrails works with bundler. Ususally `bundle exec` (which is slow) is not needed. `gem 'rrails'` is not required in Gemfile, either.
 
-* it can't run "rake -T"
-* it can't use zsh's histroy.
+In case you want to make sure Gemfile is in use, or rrails version is specified in Gemfile, just run this before others:
 
-So I wrote rrails.
+    $ bundle exec rrails start
+
+### PTY mode
+
+rrails's PTY mode makes sure that interactive things (like line editing)
+work correctly. Note it also redirect all STDERR to STDOUT and keys like `^C` 
+may not work correctly.
+
+PTY mode is enabled only for `rails console` and `rails db` by default.
+If you need an interactive console for other commands, you can add `--pty` option:
+
+    $ rrails --pty rails server            # if debugger is in use
+
+Note: PTY mode does not support nested programs. For example, `pry` runs `less` 
+as its pager. This doesn't work properly. You need disable the pager of pry:
+
+    Pry.config.pager = false
+
+### The server
+
+By default, rrails will start a server process on demand per project per rails\_env.
+The server writes pid and socket files to `./tmp/` and remove them when exiting.
+
+You can control the server using:
+
+    $ export RAILS_ENV=development         # optionally
+    $ rrails stop
+    $ rrails restart
+    $ rrails reload
+    $ rrails status
 
 ## See Also
 
@@ -62,7 +108,7 @@ So I wrote 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.

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{remote run rails/rake command}
   gem.email = "walf443@gmail.com"
   gem.authors = ["Keiji, Yoshimi"]
+  gem.extra_rdoc_files = %w[Changes.md README.md LICENSE.txt]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.4.0
+1.0.0

data/bin/rrails

@@ -1,6 +1,93 @@
 #!/usr/bin/env ruby
 
 $:.unshift File.expand_path('../../lib', __FILE__)
-require 'rrails'
-require 'rrails/client'
-RemoteRails::Client.new_with_options(ARGV).run
+
+# goto project root
+def chdir_to_project_root
+  while not File.exists?('Gemfile') do
+    Dir.chdir('..')
+    break if Dir.pwd == '/'
+  end
+  if not File.exists?('Gemfile')
+    raise RuntimeError.new('Can not locate project root')
+  end
+end
+
+# parse options
+require 'optparse'
+options = { ondemand: true }
+opts = OptionParser.new
+opts.banner =<<'!'
+Usage: rrails [options] [-- rails_or_rake_cmds]
+       rrails [options] start | stop | restart | reload | status
+       rrails shellrc
+       rrails --help
+
+Options:
+!
+opts.on('-h', '--help', 'Show this document.')      {}
+opts.on('-E', '--rails_env=s', 'Set Rails env.')      {|v| options[:rails_env] = v}
+opts.on('-s', '--socket=s', 'Set RRails server socket file. If this is set, host and port are ignored.') {|v| options[:socket] = v}
+opts.on('--host=s', 'Set server hostname. Default: localhost.') {|v| options[:host] = v}
+opts.on('-p', '--port=i', 'Set server port. Default: decided by rails_env.') {|v| options[:port] = v}
+opts.on('--[no-]ondemand', '(Client) Start RRails server on demand. Default: true.') {|v| options[:ondemand] = v}
+opts.on('-t', '--[no-]pty', "(Client) Prepare a PTY. Default: decided by commands.")  {|v| options[:pty] = v }
+opts.on('--logfile=s', '(Server) Set log file path. Default: (stderr).') {|v| options[:logfile] = v}
+opts.on('--pidfile=s', '(Server) Set RRails server pidfile file.') {|v| options[:pidfile] = v}
+opts.on('-b', '--[no-]background', '(Server) Run in background.') {|v| options[:background] = v}
+opts.parse!(ARGV)
+
+# run client or server
+case ARGV.first
+when nil, ''
+  # show help
+  STDERR.puts opts
+when /^s(erver)$/
+when 'start', 'stop', 'reload', 'restart', 'status'
+  # server
+  chdir_to_project_root
+  require 'rrails/server'
+  RemoteRails::Server.new(options).send(ARGV.first)
+when /shellrc/
+  # shell rc
+  rc = <<-"!"
+    rrails-exec() {
+        if [ -e config/environment.rb ]; then
+            "#{__FILE__}" -- "$@"
+        else
+            command "$@"
+        fi
+    }
+    alias rrails="#{__FILE__}"
+    alias rails='rrails-exec rails'
+    alias rake='rrails-exec rake'
+  !
+  rc.gsub! /^    /, ''
+  puts rc
+else
+  chdir_to_project_root
+
+  # check server and start server on demand
+  if options[:ondemand]
+    options[:ondemand_callback] = proc do
+      require 'rrails/server'
+      require 'bundler/setup'
+      options[:background] = true
+      server = RemoteRails::Server.new(options)
+      if not server.alive?
+        puts 'Starting RRails server on demand ...'
+        server.start
+        sleep 1 while not server.alive?
+      end
+    end
+  end
+
+  # start client
+  require 'rrails/client'
+  require 'shellwords'
+
+  options[:cmd] = Shellwords.join(ARGV)
+  exitcode = RemoteRails::Client.new(options).run
+  exit exitcode
+end
+

data/bin/rrails-server

@@ -2,6 +2,9 @@
 
 ENV["RAILS_ENV"] ||= ARGV.shift
 $:.unshift File.expand_path('../../lib', __FILE__)
+warn "-------------------------------------------------------------------------------------------------------------"
+warn "rrails-server command is obsolate. This command will be deleted in future. Please use 'rrails start' instead."
+warn "-------------------------------------------------------------------------------------------------------------"
 require 'rrails'
 require 'rrails/server'
 RemoteRails::Server.new.start

data/lib/rrails/client.rb

@@ -1,7 +1,5 @@
 require 'socket'
 require 'rrails'
-require 'shellwords'
-require 'optparse'
 require 'io/console'
 
 module RemoteRails
@@ -17,32 +15,27 @@ module RemoteRails
   #   client.run
   #
   class Client
-    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', '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
-      self.new(options)
-    end
-
     def initialize(options={})
       @cmd = options[:cmd] || ""
-      @host = options[:host] || 'localhost'
+
       @rails_env = options[:rails_env] || ENV['RAILS_ENV'] || 'development'
+
+      @socket = "#{options[:socket] || './tmp/sockets/rrails-'}#{@rails_env}.socket"
+      @host = options[:host] || 'localhost'
       @port = options[:port] || DEFAULT_PORT[@rails_env]
+
       @use_pty = options[:pty]
+      @ondemand_callback = options[:ondemand_callback]
+
+      if @cmd.is_a? Array
+        require 'shellwords'
+        @cmd = Shellwords.join(@cmd)
+      end
+
+      if (options[:host] || options[:port]) && (!options[:socket])
+        @socket = nil
+      end
+
       if @use_pty.nil?
         # decide use_pty from cmd
         case @cmd
@@ -53,12 +46,16 @@ module RemoteRails
     end
 
     def run
-      if @cmd.empty?
-        STDERR.puts Client.opts_parser
-        return
+      sock = nil
+      begin
+        sock = connect
+      rescue
+        if @ondemand_callback
+          @ondemand_callback.call
+          sock = connect
+        end
       end
 
-      sock = TCPSocket.open(@host, @port)
       sock.puts("#{@use_pty ? 'P' : ' '}#@cmd")
       running = true
 
@@ -80,7 +77,7 @@ module RemoteRails
         while running && line = sock.gets
           case line.chomp
           when /^EXIT\t(.+)$/
-            exit($1.to_i)
+            return $1.to_i
           when /^OUT\t(.+)$/
             STDOUT.write($1.split(',').map(&:to_i).pack('c*'))
           when /^ERR\t(.+)$/
@@ -92,12 +89,26 @@ module RemoteRails
         running = false
       rescue Interrupt
         running = false
-        exit 130
+        return 130
+      ensure
+        running = false
+        thread.kill
       end
 
-      STDERR.puts "\nERROR: RRails server disconnected"
-      exit -1
+      STDERR.puts "\r\nERROR: RRails server disconnected"
+      return -1
+    end
+
+    private
+
+    def connect
+      if @socket
+        UNIXSocket.open(@socket)
+      else
+        TCPSocket.open(@host, @port)
+      end
     end
 
   end
+
 end

data/lib/rrails/server.rb

@@ -6,6 +6,8 @@ require 'stringio'
 require 'shellwords'
 require 'pty'
 require 'benchmark'
+require 'fileutils'
+
 
 # FIXME: rails command require APP_PATH constants.
 APP_PATH = File.expand_path('./config/application')
@@ -20,55 +22,138 @@ module RemoteRails
     PAGE_SIZE = 4096
 
     def initialize(options={})
-      @rails_env = options[:rails_env] || ENV['RAILS_ENV'] || "development"
-      @app_path = File.expand_path('./config/application')
-      # should not access to outside
-      @host = 'localhost'
-      @port = options[:port] || DEFAULT_PORT[@rails_env]
-      @logger = Logger.new(options[:logfile] ? options[:logfile] : $stderr)
+      @rails_env  = options[:rails_env] || ENV['RAILS_ENV'] || "development"
+      @pidfile    = "#{options[:pidfile] || './tmp/pids/rrails-'}#{@rails_env}.pid"
+      @background = options[:background] || false
+      @host       = options[:host] || 'localhost'
+      @port       = options[:port] || DEFAULT_PORT[@rails_env]
+      @socket     = "#{options[:socket] || './tmp/sockets/rrails-'}#{@rails_env}.socket"
+      if (options[:host] || options[:port]) && !options[:socket]
+        @socket = nil
+      end
+      @app_path   = File.expand_path('./config/application')
+      @logger     = Logger.new(options[:logfile] ? options[:logfile] : (@background ? nil : STDERR))
+    end
+
+    def stop
+      pid = previous_instance
+      if pid
+        @logger.info "stopping previous instance #{pid}"
+        Process.kill :TERM, pid
+        FileUtils.rm_f [@socket, @pidfile]
+        return true
+      end
+    end
+
+    def restart
+      stop && sleep(1)
+      start
+    end
+
+    def reload
+      pid = previous_instance
+      Process.kill :HUP, pid
+    end
+
+    def alive?
+      previous_instance ? true : false
+    end
+
+    def status
+      pid = previous_instance
+      if pid
+        puts "running \tpid = #{pid}"
+      else
+        puts 'stopped'
+      end
     end
 
     def start
-      self.boot_rails
-      server = TCPServer.open(@host, @port)
-      @logger.info("starting rrails server on #{@host}:#{@port}")
-
-      [:INT, :TERM].each do |sig|
-        trap(sig) do
-          @logger.info("SIG#{sig} recieved. shutdown...")
-          exit
+      # check previous process
+      raise RuntimeError.new('RRails is already running') if alive?
+
+      if @background
+        pid = Process.fork do
+          @background = false
+          start
         end
+        Process.detach(pid)
+        return
       end
 
-      trap(:HUP) do
-        @logger.info("SIGHUP recieved. reload...")
-        ActionDispatch::Callbacks.new(Proc.new {}).call({})
+      # make 'bundle exec' not necessary for most time.
+      require 'bundler/setup'
+
+      begin
+        [@pidfile, @socket].compact.each do |path|
+          FileUtils.rm_f path
+          FileUtils.mkdir_p File.dirname(path)
+        end
+
+        File.write(@pidfile, $$)
+        server = if @socket
+                   UNIXServer.open(@socket)
+                 else
+                   TCPServer.open(@host, @port)
+                 end
+        server.close_on_exec = true
+
+        @logger.info("starting rrails server: #{@socket || "#{@host}:#{@port}"}")
+
+        [: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({})
+          self.boot_rails
+        end
+
         self.boot_rails
-      end
-      Thread.abort_on_exception = true
-      loop do
-        Thread.start(server.accept) do |s|
-          begin
-            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)
+
+        Thread.abort_on_exception = true
+
+        loop do
+          Thread.start(server.accept) do |s|
+            @logger.debug("accepted")
+            begin
+              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
+              exitcode = status ? status.exitstatus || (status.termsig + 128) : 0
+              s.puts("EXIT\t#{exitcode}")
+              s.flush
+              @logger.info("finished: #{line} (#{time} seconds)")
+            rescue Errno::EPIPE
+              @logger.info("disconnected: #{line}")
             end
-            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
+      ensure
+        server.close unless server.closed?
+        @logger.info("cleaning pid and socket files...")
+        FileUtils.rm_f [@socket, @pidfile].compact
       end
     end
 
     def boot_rails
       @logger.info("prepare rails environment (#{@rails_env})")
       ENV["RAILS_ENV"] = @rails_env
+
+      # make IRB = Pry hacks (https://gist.github.com/941174) work:
+      # pre-require all irb compoments needed in rails/commands
+      # otherwise 'module IRB' will cause 'IRB is not a module' error.
+      require 'irb'
+      require 'irb/completion'
+
       require File.expand_path('./config/environment')
 
       unless Rails.application.config.cache_classes
@@ -79,7 +164,6 @@ module RemoteRails
     end
 
     def dispatch(sock, line, pty=false)
-
       if pty
         m_out, c_out = PTY.open
         c_in = c_err = c_out
@@ -96,6 +180,8 @@ module RemoteRails
       end
 
       running = true
+      heartbeat = 0
+
       pid = fork do
         m_fds.map(&:close) if not pty
         STDIN.reopen(c_in)
@@ -143,11 +229,15 @@ module RemoteRails
         end
 
         # send heartbeat so that we got EPIPE immediately when client dies
-        sock.puts("PING")
-        sock.flush
+        heartbeat += 1
+        if heartbeat > 20
+          sock.puts("PING")
+          sock.flush
+          heartbeat = 0
+        end
 
         # do not make CPU hot
-        sleep 0.1
+        sleep 0.025
       end
     ensure
       running = false
@@ -163,24 +253,36 @@ module RemoteRails
       thread.kill if thread
     end
 
+    private
+
     def execute(cmd, *args)
       ARGV.clear
       ARGV.concat(args)
+      $0 = cmd
       case cmd
       when 'rails'
         require 'rails/commands'
       when 'rake'
+        # full path of rake
+        $0 = Gem.bin_path('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
         STDERR.puts "#{cmd} is not supported in RRails."
       end
     end
 
+    def previous_instance
+      begin
+        previous_pid = File.read(@pidfile).to_i
+
+        if previous_pid > 0 && Process.kill(0, previous_pid)
+          return previous_pid
+        end
+        return false
+      rescue Errno::ESRCH, Errno::ENOENT
+        return false
+      end
+    end
+
   end
 end

data/rrails.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rrails"
-  s.version = "0.4.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Keiji, Yoshimi"]
@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.email = "walf443@gmail.com"
   s.executables = ["rrails", "rrails-server"]
   s.extra_rdoc_files = [
+    "Changes.md",
     "LICENSE.txt",
     "README.md"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rrails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -98,6 +98,7 @@ executables:
 - rrails-server
 extensions: []
 extra_rdoc_files:
+- Changes.md
 - LICENSE.txt
 - README.md
 files:
@@ -132,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3003535707070342098
+      hash: 4515075186478304892
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: