spinoff 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in spinoff.gemspec
+gemspec

data/README.md

@@ -0,0 +1,89 @@
+# Spinoff
+
+Spinoff will help you to speed up your Ruby test workflow.
+
+It does that by preloading your environment and then using functions like
+`fork` for each run of your test suite to avoid loading framework code
+like Rails over and over again. (it supports JRuby as well)
+
+# Credits
+
+Lots of code has been taken from the [Spin](https://github.com/jstorimer/spin)
+project by Jesse Storimer. Thanks for sharing, Jesse!
+
+# How does it work
+
+Spinoff operates with the assumption that most of the dependencies of your
+application do not change. If you are working on a Rails project, you
+probably do not have to reload all Rails classes for each test run.
+
+The `spinoff-server` command starts a server process that will listen for
+a list of test files on a unix domain socket. It will also load an init file
+which contains all code that should be preloaded.
+(like `require 'config/application'` for Rails)
+
+The `spinoff-client` command will be called with a list of test files that
+should be executed. It sends that file list to the server process via the
+unix domain socket.
+
+Once the server process receives a list of files, it will fork the Ruby process
+and execute the files with the selected test runner. All code that changes
+frequently will only be loaded in the forked process.
+
+This allows Spinoff to speed up our test suite without any knowledge of the
+frameworks and libraries we use to build our app.
+
+# How is it different from Spin?
+
+Spinoff is based on [Spin](https://github.com/jstorimer/spin) but differs on
+the following points.
+
+1. It is framework agnostic and thus needs an init file to preload code.
+   Spin does only support Rails at this time of writing.
+
+2. It works with [JRuby](http://www.jruby.org/)!
+
+# Usage
+
+Spinoff needs an init file to preload code. Please make sure you only load
+libraries that do not change between your test runs. If you change anything
+you preload in the init file, you have to restart the Spinoff server.
+
+Example:
+
+```ruby
+require 'config/application'
+require 'rspec'
+```
+
+Starting the server:
+
+    $ spinoff-server --rspec config/spinoff.rb
+
+Please use `spinoff-server --help` to show all available options.
+
+Sending a list of test files to the server:
+
+    $ spinoff-client spec/test1_spec.rb spec/foo/bar_spec.rb
+
+Spinoff should work well with autotest(ish) tools. Just start the server and
+execute the spinoff client on file changes.
+
+# JRuby Support
+
+Since JRuby does not support the fork system call, Spinoff is using a
+new `ScriptingContainer` for each test run. That also means we cannot really
+preload any code. But it saves us from starting a new JVM for each test run.
+
+# Contributing
+
+I'm happy about any kind of feedback and/or contribution.
+
+# Caveats
+
+* New and not well tested.
+* No test suite yet.
+
+# Author
+
+[Bernd Ahlers](https://github.com/bernd)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/spinoff-client

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'spinoff/client'
+
+Spinoff::Client.start(ARGV)
+
+exit 0

data/bin/spinoff-server

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'spinoff/server'
+
+config = {}
+
+parser = OptionParser.new do |o|
+  o.banner = 'Usage: spinoff-server [options] <init file>'
+
+  o.on('--rspec', 'Use rspec framework (default)') do |v|
+    config[:test_framework] = :rspec
+  end
+
+  o.on('--test-unit', 'Use test/unit framework') do |v|
+    config[:test_framework] = :testunit
+  end
+
+  o.on('-h', '--help') do
+    STDERR.puts o
+    exit 1
+  end
+end
+parser.parse!
+
+unless config[:test_framework]
+  STDERR.puts "Please select a test framework! (see --help)"
+  exit 1
+end
+
+config[:init_script] = ARGV.shift unless ARGV.empty?
+
+Spinoff::Server.start(config)
+
+exit 0

data/lib/spinoff/client.rb

@@ -0,0 +1,22 @@
+require 'socket'
+require 'spinoff/socket_path'
+
+module Spinoff
+  module Client
+    def self.start(argv)
+      files = argv.select {|f| File.exist?(f) }.uniq.join(File::PATH_SEPARATOR)
+
+      return if files.empty?
+
+      socket = UNIXSocket.open(Spinoff.socket_path)
+      socket.puts files
+
+      while line = socket.gets
+        break if line == "\0"
+        print line
+      end
+    rescue Errno::ECONNREFUSED
+      abort "Connection to spinoff server was refused."
+    end
+  end
+end

data/lib/spinoff/server.rb

@@ -0,0 +1,14 @@
+module Spinoff
+  module Server
+    def self.start(config)
+      case RUBY_PLATFORM
+      when /java/i
+        require 'spinoff/server/jruby'
+        Spinoff::Server::JRuby.start(config)
+      else
+        require 'spinoff/server/fork'
+        Spinoff::Server::Fork.start(config)
+      end
+    end
+  end
+end

data/lib/spinoff/server/fork.rb

@@ -0,0 +1,39 @@
+require 'spinoff/server/generic'
+require 'spinoff/test_runner'
+require 'benchmark'
+
+module Spinoff
+  module Server
+    class Fork < Spinoff::Server::Generic
+      def start
+        test_runner = Spinoff::TestRunner.init(config[:test_framework])
+        load_init_script(init_script)
+
+        accept_loop do |files|
+          start = Time.now
+
+          fork do
+            STDERR.puts "Loading #{files.inspect}"
+            test_runner << files
+          end
+
+          Process.wait
+
+          STDERR.puts "Execution time: %.4fs" % (Time.now - start)
+        end
+      end
+
+      private
+      def load_init_script(file)
+        if File.exist?(file)
+          sec = Benchmark.realtime do
+            require File.expand_path(file)
+          end
+          STDERR.puts "Loaded init script in %.4fs (%s)" % [sec, file]
+        else
+          STDERR.puts "WARNING: Init script '#{file}' does not exist!"
+        end
+      end
+    end
+  end
+end

data/lib/spinoff/server/generic.rb

@@ -0,0 +1,49 @@
+require 'socket'
+require 'spinoff/socket_path'
+
+module Spinoff
+  module Server
+    class Generic
+      def self.start(config)
+        new(config).start
+      end
+
+      attr_reader :config, :socket
+
+      def initialize(config)
+        @config = config
+        @socket = create_socket
+      end
+
+      def init_script
+        File.expand_path(@config.fetch(:init_script, File.join(Dir.pwd, 'spinoff.rb')))
+      end
+
+      def start
+        raise "#{self.class}#start not implemented."
+      end
+
+      def accept_loop
+        loop do
+          connection = socket.accept
+          files = connection.gets.chomp.split(File::PATH_SEPARATOR)
+
+          disconnect_client(connection)
+          yield(files)
+        end
+      end
+
+      def disconnect_client(client)
+        client.print("\0")
+        client.close
+      end
+
+      private
+      def create_socket
+        path = Spinoff.socket_path
+        File.delete(path) if File.exist?(path)
+        UNIXServer.open(path)
+      end
+    end
+  end
+end

data/lib/spinoff/server/jruby.rb

@@ -0,0 +1,44 @@
+require 'java'
+require 'spinoff/server/generic'
+require 'benchmark'
+
+module Spinoff
+  module Server
+    class JRuby < Spinoff::Server::Generic
+      import 'org.jruby.embed.PathType'
+      import 'org.jruby.embed.LocalContextScope'
+      import 'org.jruby.embed.ScriptingContainer'
+
+      def start
+        accept_loop do |files|
+          start = Time.now
+
+          STDERR.puts "Creating JRuby scripting container"
+          context = ScriptingContainer.new(LocalContextScope::SINGLETHREAD)
+
+          if File.exist?(init_script)
+            sec = Benchmark.realtime do
+              context.run_scriptlet(PathType::ABSOLUTE, init_script)
+            end
+            STDERR.puts "Loaded init script in %.4fs (%s)" % [sec, init_script]
+          else
+            STDERR.puts "WARNING: Init script '#{init_script}' does not exist!"
+          end
+
+          STDERR.puts "Loading #{files.inspect}"
+          context.put('framework', config[:test_framework])
+          context.put('files', files)
+
+          context.run_scriptlet <<-__RUBY
+            require 'spinoff/test_runner'
+            runner = Spinoff::TestRunner.init(framework)
+            runner << files
+          __RUBY
+          context.terminate
+
+          STDERR.puts "Execution time: %.4fs" % (Time.now - start)
+        end
+      end
+    end
+  end
+end

data/lib/spinoff/socket_path.rb

@@ -0,0 +1,8 @@
+require 'tempfile'
+require 'digest/md5'
+
+module Spinoff
+  def self.socket_path
+    File.join(Dir.tmpdir, [Digest::MD5.hexdigest(Dir.pwd), 'spinoff'].join('.'))
+  end
+end

data/lib/spinoff/test_runner.rb

@@ -0,0 +1,16 @@
+module Spinoff
+  module TestRunner
+    def self.init(framework)
+      STDERR.puts "Test framework: #{framework}"
+
+      case framework
+      when :rspec
+        require 'spinoff/test_runner/rspec'
+        Spinoff::TestRunner::RSpec.new
+      when :testunit
+        require 'spinoff/test_runner/test_unit'
+        Spinoff::TestRunner::TestUnit.new
+      end
+    end
+  end
+end

data/lib/spinoff/test_runner/rspec.rb

@@ -0,0 +1,17 @@
+require 'rspec/core'
+
+module Spinoff
+  module TestRunner
+    class RSpec
+      def <<(files)
+        # Overwrite the trap_interrupt method to avoid weird behaviour
+        # on SIGINT.
+        ::RSpec::Core::Runner.class_eval do
+          def self.trap_interrupt; end
+        end
+
+        ::RSpec::Core::Runner.run(files)
+      end
+    end
+  end
+end

data/lib/spinoff/test_runner/test_unit.rb

@@ -0,0 +1,9 @@
+module Spinoff
+  module TestRunner
+    class TestUnit
+      def <<(files)
+        Array(files).each {|file| require File.expand_path(file) }
+      end
+    end
+  end
+end

data/lib/spinoff/version.rb

@@ -0,0 +1,3 @@
+module Spinoff
+  VERSION = "0.0.1"
+end

data/spinoff.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/spinoff/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bernd Ahlers"]
+  gem.email         = ["bernd@tuneafish.de"]
+  gem.description   = %q{Environment preloader}
+  gem.summary       = %q{Spinoff preloads your Ruby environment based on an initialization file.}
+  gem.homepage      = "https://github.com/bernd/spinoff"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "spinoff"
+  gem.require_paths = ["lib"]
+  gem.version       = Spinoff::VERSION
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: spinoff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bernd Ahlers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-26 00:00:00.000000000 Z
+dependencies: []
+description: Environment preloader
+email:
+- bernd@tuneafish.de
+executables:
+- spinoff-client
+- spinoff-server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/spinoff-client
+- bin/spinoff-server
+- lib/spinoff/client.rb
+- lib/spinoff/server.rb
+- lib/spinoff/server/fork.rb
+- lib/spinoff/server/generic.rb
+- lib/spinoff/server/jruby.rb
+- lib/spinoff/socket_path.rb
+- lib/spinoff/test_runner.rb
+- lib/spinoff/test_runner/rspec.rb
+- lib/spinoff/test_runner/test_unit.rb
+- lib/spinoff/version.rb
+- spinoff.gemspec
+homepage: https://github.com/bernd/spinoff
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Spinoff preloads your Ruby environment based on an initialization file.
+test_files: []