waiting_on_rails 0.0.1

data/LICENSE

@@ -0,0 +1,17 @@
+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,49 @@
+[![Build Status](https://travis-ci.org/AndrewRadev/waiting-on-rails.png)](https://travis-ci.org/AndrewRadev/waiting-on-rails)
+
+Bored of waiting on `rails server` or `rake routes`? No more! This gem provides two commands, `waiting-on-rails` and `waiting-on-rake`. They are meant as replacements to `rails` and `rake`, respectively, so you can call them like this:
+
+    waiting-on-rails server
+    waiting-on-rake db:migrate
+
+What's the difference? Aside from running the required task, they also play some relaxing elevator music, so you'll never get bored of waiting again. Problem solved!
+
+## Gotchas
+
+Okay, so `waiting-on-rails` only plays music for the `server` task, not for the similarly long-loading `console` cousin, but I have no idea how to run the console in a child process and control its IO. Pull requests welcome. And `waiting-on-rake` only plays music for long-running tasks (see `slow_tasks` method in [this file](https://github.com/AndrewRadev/waiting-on-rails/blob/master/lib/waiting_on_rails/rake.rb)), but that's intentional.
+
+Also, it only works for the following webservers:
+
+  - WEBrick
+  - Mongrel
+  - Thin
+
+It should be possible to add support for more by adding to the `matches_server_start?` method in [this file](https://github.com/AndrewRadev/waiting-on-rails/blob/master/lib/waiting_on_rails/rails.rb). Again, pull requests welcome.
+
+## Installation and Usage Details
+
+The first thing you need to do is install the gem (note the underscores):
+
+    gem install waiting_on_rails
+
+The gem requires `mplayer` to play its music. On a Mac, you can install mplayer with homebrew:
+
+    brew install mplayer
+
+On Linux, you should use your distribution's package manager. For Arch Linux, the command would be:
+
+    pacman -S mplayer
+
+You could run `waiting-on-rails` without using `bundle exec` (unless it's run by a bundle-exec-ed script, like with a Procfile), but you probably won't be able to with `waiting-on-rake`. So if you're serious about battling boring loading times, you're going to have to add it to your Gemfile with a `:require => false`. If you just want a quick laugh, install the gem globally and start your project with `waiting-on-rails s`. Preferably in front of your unsuspecting coworkers. Amusement not guaranteed, but very likely.
+
+## TODO
+
+  - Implement `waiting-on-spork`?
+  - Implement continuing from a point. Could save a temporary file somewhere with the time at which the music was stopped.
+  - Implement simple configuration, controlling what song to play, or even something different to do (like show a notification). Warning: might make the project actually useful, consider carefully.
+
+## Music sources
+
+Both music sources are CC-licensed and can be found at the following urls:
+
+  - Elevator music: http://www.jamendo.com/en/list/a98147/echoes-from-the-past
+  - Elevator ding: http://soundbible.com/1441-Elevator-Ding.html

data/bin/waiting-on-rails

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'waiting_on_rails/player'
+require 'waiting_on_rails/rails'
+
+music = WaitingOnRails::Player.new('attempt_1.mp3')
+ding  = WaitingOnRails::Player.new('ding.wav')
+
+WaitingOnRails::Rails.new(music, ding).run(ARGV)

data/bin/waiting-on-rake

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'waiting_on_rails/rake'
+
+music = WaitingOnRails::Player.new('attempt_1.mp3')
+ding  = WaitingOnRails::Player.new('ding.wav')
+
+WaitingOnRails::Rake.new(music, ding).run(ARGV)

data/lib/waiting_on_rails/player.rb

@@ -0,0 +1,28 @@
+module WaitingOnRails
+  class Player
+    attr_reader :pid
+
+    def initialize(music_path)
+      @music_path = full_path(music_path)
+    end
+
+    def start
+      @pid = spawn("mplayer #{@music_path}", :out => '/dev/null', :err => '/dev/null')
+    end
+
+    def stop
+      return true if @pid.nil?
+      Process.kill(15, @pid)
+      Process.wait(@pid)
+      true
+    rescue Errno::ESRCH, Errno::ECHILD
+      false
+    end
+
+    private
+
+    def full_path(path)
+      File.expand_path("#{File.dirname(__FILE__)}/../../vendor/#{path}")
+    end
+  end
+end

data/lib/waiting_on_rails/rails.rb

@@ -0,0 +1,91 @@
+require 'pty'
+require 'waiting_on_rails/player'
+
+module WaitingOnRails
+  class Exit < Exception; end
+
+  class Rails
+    def initialize(music_player, ding_player = nil)
+      @music_player = music_player
+      @ding_player  = ding_player
+    end
+
+    def run(args)
+      if not should_play_music?(args)
+        exec_rails_command(args)
+      end
+
+      spawn_rails_subprocess(args) do |output, pid|
+        @music_player.start
+        handle_signals(pid, output)
+        main_loop(output)
+      end
+    rescue Exit
+      exit(1)
+    ensure
+      @music_player.stop
+    end
+
+    private
+
+    def spawn_rails_subprocess(args)
+      PTY.spawn('rails', *args) do |output, input, pid|
+        yield output, pid
+      end
+    end
+
+    def exec_rails_command(args)
+      exec 'rails', *args
+    end
+
+    def main_loop(io)
+      loop do
+        begin
+          line = io.readline
+          puts line
+          if matches_server_start?(line)
+            @music_player.stop
+            sleep 0.5
+            @ding_player.start if @ding_player
+          end
+        rescue EOFError
+          break
+        rescue Errno::EIO
+          raise Exit
+        end
+      end
+    end
+
+    def handle_signals(pid, output)
+      %w(TERM INT).each do |signal|
+        Signal.trap(signal) do
+          Process.kill(signal, pid)
+
+          loop do
+            begin
+              puts output.readline
+            rescue EOFError
+              break
+            end
+          end
+
+          raise Exit
+        end
+      end
+    end
+
+    def should_play_music?(args)
+      File.exists?('script/rails') and args.find { |arg| ['server', 's'].include? arg }
+    end
+
+    def matches_server_start?(string)
+      patterns = [
+        'WEBrick::HTTPServer#start', # WEBrick
+        'Listening on',              # Thin
+        'Ctrl-C to shutdown',        # Mongrel
+      ]
+
+      patterns.any? { |p| string.include?(p) }
+    end
+  end
+end

data/lib/waiting_on_rails/rake.rb

@@ -0,0 +1,70 @@
+require 'waiting_on_rails/player'
+
+module WaitingOnRails
+  class Rake
+    def initialize(music_player, ding_player = nil)
+      @music_player = music_player
+      @ding_player  = ding_player
+    end
+
+    def run(args)
+      if given_tasks_are_slow?(args)
+        @music_player.start
+        Process.wait(spawn_rake_subprocess(args))
+      else
+        exec_rake_command(args)
+      end
+      @music_player.stop
+      sleep 0.5
+      @ding_player.start if @ding_player
+    ensure
+      @music_player.stop
+    end
+
+    private
+
+    def given_tasks_are_slow?(args)
+      args.any? { |task| slow_tasks.include?(task) }
+    end
+
+    def slow_tasks
+      [
+        'db:create',
+        'db:drop',
+        'db:fixtures:load',
+        'db:migrate',
+        'db:migrate:status',
+        'db:rollback',
+        'db:schema:dump',
+        'db:schema:load',
+        'db:seed',
+        'db:setup',
+        'db:structure:dump',
+        'db:version',
+        'routes',
+        'spec',
+        'spec:controllers',
+        'spec:helpers',
+        'spec:lib',
+        'spec:mailers',
+        'spec:models',
+        'spec:rcov',
+        'spec:requests',
+        'spec:routing',
+        'spec:views',
+        'stats',
+        'test',
+        'test:recent',
+        'test:uncommitted',
+      ]
+    end
+
+    def exec_rake_command(args)
+      exec 'rake', *args
+    end
+
+    def spawn_rake_subprocess(args)
+      spawn 'rake', *args
+    end
+  end
+end

data/lib/waiting_on_rails/version.rb

@@ -0,0 +1,3 @@
+module WaitingOnRails
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: waiting_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Radev
+- Joan Karadimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Bored of waiting on \"rails server\"? No more! This gem plays
+  some nice\n    elevator music when you run `waiting-on-rails server` and stops it
+  when the\n    server is ready.\n"
+email:
+- andrey.radev@gmail.com
+executables:
+- waiting-on-rails
+- waiting-on-rake
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/waiting_on_rails/player.rb
+- lib/waiting_on_rails/rake.rb
+- lib/waiting_on_rails/rails.rb
+- lib/waiting_on_rails/version.rb
+- lib/waiting_on_rails.rb
+- bin/waiting-on-rake
+- bin/waiting-on-rails
+- vendor/attempt_1.mp3
+- vendor/attempt_2.mp3
+- vendor/test.mp3
+- vendor/ding.wav
+- LICENSE
+- README.md
+homepage: http://github.com/AndrewRadev/waiting_on_rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1546165163177782417
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: waiting_on_rails
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Plays elevator music until `rails server` boots
+test_files: []