spork_tasks 1.0.0 → 1.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    spork_tasks (1.1.1)
+      rake
+      spork
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    spork (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  spork_tasks!

data/README.md

@@ -1,24 +1,23 @@
 Spork Tasks
 ===========
-Spork is kind of annoying to deal with. I just want it to run in the background and have an easy way to restart, start, and stop it. So here are my tasks for doing that. 
-
-You can copy the rake tasks wherever you like, but I've packaged them as a rails generator
+Run spork in the background! Provides rake tasks for an easy way to start, stop, restart spork. 
 
 Installing
 ----------
     
-    gem install spork_tasks
-    
-    # If you're using Bundler:
-    gem 'spork_tasks', '~> 1.0.0'
-    
-    rails generate spork_tasks
-    # Copies the rake file for you.
+    # In your Gemfile:
+    gem 'spork_tasks', '~> 1.1.0'
+
+    # Add the following line to your Rakefile
+    require 'spork/tasks'
 
 Tasks
 -----
     rake spork:start
     # Starts the server
+
+    rake spork:start[5678]
+    # Starts spork on port 5768
     
     rake spork:stop
     # Stops the server
@@ -26,6 +25,3 @@ Tasks
     rake spork:restart
     # Restarts spork
     
-TODO
-----
-Better process management. Instead of guessing how long to wait (and sleep) for Rails to start, actually wait for it to start before handing the command line back.

data/lib/spork/task_helper.rb

@@ -0,0 +1,148 @@
+require 'spork'
+require 'spork/runner'
+require 'rake'
+require 'socket'
+require 'timeout'
+
+# Let's fork spork and put in the background and forget about it.
+# You can start|stop|restart spork using this rake task
+#
+# Examples
+#
+#   rake spork:start
+#   # => starts spork and detaches the process
+#
+#   rake spork:stop
+#   # => kills the spork process based on the pid stored in tmp/spork.pid
+#
+#   rake spork:restart
+#   # => stops then starts spork
+#
+
+module Spork
+  class TaskHelper
+
+    include Rake::DSL if defined? Rake::DSL
+
+    def install
+      namespace :spork do
+        desc "Start spork server"
+        task :start, :port do |_, args|
+          port = args[:port]
+          start_spork(port)
+        end
+
+        desc "Stop spork server"
+        task :stop do
+          stop_spork
+        end
+
+        desc "Restart spork server"
+        task :restart => [:stop, :start]
+      end
+    end
+
+    def start_spork(port = nil)
+      options = []
+      options << "-p#{port}" if port
+      runner = Spork::Runner.new(options, $stderr, $stderr)
+      port = port || runner.find_test_framework.default_port
+
+      if port_bound?(port) || process_running?
+        puts "\033[33m[Spork already running on port #{port}]\033[0m"
+        return
+      end
+
+      begin
+        pid = fork do
+          $stdout = File.new('/dev/null', 'w')
+          begin
+            runner.run
+          rescue => e
+            $stderr.puts
+            $stderr.puts "#{e.class} => #{e.message}"
+            $stderr.puts e.backtrace.join("\n")
+          end
+        end
+
+        # Detach the pid, keep track of the pid, and wait for Rails to start.
+        Process.detach(pid)
+        File.open(pid_file, "w"){|f| f.write pid}
+
+        print "Starting spork..."
+        timeout = 20
+        seconds = 0
+        until port_bound?(port)
+          print '.'; $stdout.flush
+          seconds += 1
+          break if seconds > timeout
+          sleep 1
+        end
+
+        # See if the process actually started
+        if process_running?
+          puts  "\033[32m[Spork running in background with pid #{pid}]\033[0m\n"
+        else
+          puts  "\033[31m[Spork failed to start]\033[0m\n"
+        end
+      rescue StandardError => e
+        puts e.inspect
+        puts  "\033[31m[Spork failed to start]\033[0m\n"
+        stop_spork
+      end
+    end
+
+    def stop_spork
+      print "Stopping spork..."
+      if pid_to_kill = pid
+        begin
+          Process.kill("INT", pid_to_kill)
+          print "\033[32m[OK]\033[0m\n"
+          sleep 1
+        rescue Errno::ESRCH => e
+          print "\033[33m[not running]\033[0m\n"
+        rescue StandardError => e
+          print "\033[31m[FAILED]\033[0m\n"
+          puts e.inspect
+        end
+      else
+        print "\033[33m[not running]\033[0m\n"
+      end
+    end
+
+    def pid_file
+      dir = File.join(Rails.root, 'tmp')
+      File.join(dir, 'spork.pid')
+    end
+
+    def pid
+      return unless File.exist?(pid_file)
+      File.read(pid_file).to_i
+    end
+
+    def process_running?
+      begin
+        Process.kill(0, pid)
+        return true
+      rescue Errno::ESRCH => e
+        return false
+      end
+    end
+
+    def port_bound?(port)
+      begin
+        Timeout::timeout(1) do
+          begin
+            s = TCPSocket.new('localhost', port)
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        end
+      rescue Timeout::Error
+        return false
+      end
+    end
+  end
+end

data/lib/spork/tasks.rb

@@ -0,0 +1,2 @@
+require 'spork/task_helper'
+Spork::TaskHelper.new.install

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'spork_tasks'
+
+

data/spec/task_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe SporkTasks do
+  describe 'install_tasks' do
+
+    it "defines Rake tasks" do
+      names = %w[spork:start spork:stop spork:restart]
+
+      names.each { |name|
+        expect { Rake.application[name] }.to raise_error(/Don't know how to build task/)
+      }
+
+      SporkTasks.new.install
+
+      names.each { |name|
+        expect { Rake.application[name] }.not_to raise_error
+        expect(Rake.application[name]).to be_instance_of Rake::Task
+      }
+    end
+  end
+end

data/spork_tasks.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "spork_tasks"
-  s.version     = "1.0.0"
+  s.version     = "1.1.1"
   s.authors     = ["Tyler Montgomery"]
   s.email       = ["tyler.a.montgomery@gmail.com"]
   s.homepage    = ""
@@ -12,4 +12,9 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
+
+  s.add_dependency 'rake'
+  s.add_dependency 'spork'
+
+  s.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spork_tasks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-28 00:00:00.000000000Z
-dependencies: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: start|stop|restart tasks to manage the Spork drb server
 email:
 - tyler.a.montgomery@gmail.com
@@ -18,10 +66,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
-- lib/rails/generators/spork_tasks/spork.rake
-- lib/rails/generators/spork_tasks/spork_tasks_generator.rb
+- lib/spork/task_helper.rb
+- lib/spork/tasks.rb
+- spec/spec_helper.rb
+- spec/task_spec.rb
 - spork_tasks.gemspec
 homepage: ''
 licenses: []
@@ -35,15 +87,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3397655467472293831
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3397655467472293831
 requirements: []
 rubyforge_project: spork_tasks
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rake tasks for managing Spork

data/lib/rails/generators/spork_tasks/spork.rake

@@ -1,108 +0,0 @@
-require 'spork'
-require 'spork/runner'
-# Let's fork spork and put in the background and forget about it.
-# You can start|stop|restart spork using this rake task
-#
-# Examples
-#
-#   rake spork:start
-#   # => starts spork and detaches the process
-#
-#   rake spork:stop
-#   # => kills the spork process based on the pid stored in tmp/spork.pid
-#
-#   rake spork:restart
-#   # => stops then starts spork
-#
-namespace :spork do
-  desc "Starts spork server"
-  task :start do
-    begin
-      print "Starting spork..."
-      
-      pid = fork do
-        # Swallows spork's notifications. I don't want it spewing all over my terminal from the background.
-        $stdout = File.new('/dev/null', 'w')
-        # If you want to change the default config you can
-        # specify the command line options here
-        # For example to change the port:
-        # options = ["--port", "7443"]
-        options = []
-        begin
-          Spork::Runner.run(options, $stderr, $stderr)
-        rescue => e
-          $stderr.puts
-          $stderr.puts "#{e.class} => #{e.message}"
-          $stderr.puts e.backtrace.join("\n")
-        end
-        # TODO maybe swallow stderr now... will that work?
-        # It should b/c its in the same process... or does spork hijack it?
-        # $stderr = File.new('/dev/null', 'w')
-      end
-     
-      # Detach the pid, keep track of the pid, and wait for Rails to start.
-     
-      Process.detach(pid)
-      File.open("#{tmp_dir}/spork.pid", "w"){|f| f.write pid}
-     
-      seconds = 15
-     
-      puts  "\033[35m[Giving Rails #{seconds} seconds to start]\033[0m\n"
-      puts "\033[36mYou can change the wait time in lib/tasks/spork.rake \nif Rails is taking longer than #{seconds} seconds to load\033[0m\n"
-     
-      sleep seconds
-      
-      # See if the process actually started
-      if process_running?(pid)
-        puts  "\033[32m[Sporkified!]\033[0m\n"
-      else
-        puts  "\033[31m[Spork failed to start]\033[0m\n"
-      end
-    rescue StandardError => e
-      puts e.inspect
-      puts  "\033[31m[Spork failed to start]\033[0m\n"
-      
-    end
-  end
-  
-  desc "Stops the spork server"
-  task :stop do
-    print "Stopping spork..."
-    if File.exist?("#{tmp_dir}/spork.pid")
-      pid = File.read("#{tmp_dir}/spork.pid").to_i
-      begin
-        Process.kill("INT", pid)
-        print "\033[32m[OK]\033[0m\n"
-        sleep 1
-      rescue Errno::ESRCH => e
-        print "\033[33m[not running]\033[0m\n"
-      rescue StandardError => e
-        print "\033[31m[FAILED]\033[0m\n"
-        puts e.inspect
-      end
-    else
-      print "\033[33m[not running]\033[0m\n"
-    end
-    print "\033[30mis it a spoon? is it a fork?\033[0m\n"
-  end
-  
-  desc "Restart the spork server"
-  task :restart => [:stop, :start]
-  
-  def tmp_dir
-    File.expand_path('../../../tmp', __FILE__)
-  end
-  
-  def process_running?(pid=nil)
-    unless pid
-      return unless File.exist?("#{tmp_dir}/spork.pid")
-      pid = File.read("#{tmp_dir}/spork.pid").to_i
-    end
-    begin
-      Process.kill(0, pid)
-    rescue Errno::ESRCH => e
-      return false
-    end
-  end
-  
-end

data/lib/rails/generators/spork_tasks/spork_tasks_generator.rb

@@ -1,10 +0,0 @@
-class SporkTasksGenerator < Rails::Generators::Base
-  source_root File.expand_path("../.", __FILE__)
- 
-  def copy_rake_tasks
-    puts "="*45
-    puts "Copying spork.rake into lib/tasks/"
-    puts "="*45
-    copy_file "spork.rake", "lib/tasks/spork.rake"
-  end
-end