zozo 1.0.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010 Jeremy Evans
+
+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 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.rdoc

@@ -0,0 +1,61 @@
+= What?
+
+zozo is a tool that makes it easy to reduce the memory footprint of your applications by having them not load rubygems/bundler at runtime:
+
+  $ unicorn -c unicorn.conf -D
+  $ ps ux
+  USER       PID %CPU %MEM   VSZ   RSS TT  STAT  STARTED       TIME COMMAND
+  jeremy   18226  0.0  0.5 17196  4496 ??  S      1:34PM    0:00.01 ruby: unicorn master -c unicorn.conf -D (ruby)
+  jeremy    8473 31.3  3.3 27180 30172 ??  S      1:34PM    0:00.62 ruby: unicorn worker[0] -c unicorn.conf -D (ruby)
+
+  $ zozo -R config.ru unicorn
+  $ ruby -I lib bin/unicorn -c unicorn.conf -D
+  $ ps ux
+  USER       PID %CPU %MEM   VSZ   RSS TT  STAT  STARTED       TIME COMMAND
+  jeremy   17561  0.0  0.4  5548  3908 ??  S      1:35PM    0:00.01 ruby: unicorn master -c unicorn.conf -D (ruby)
+  jeremy   22626  4.2  2.0 15016 17904 ??  S      1:35PM    0:00.25 ruby: unicorn worker[0] -c unicorn.conf -D (ruby)
+
+As you can see, the memory footprint is reduced dramatically:
+
+  master process:
+    VSZ: 5548/17196  => 68% reduction
+    RSS: 3908/4496   => 13% reduction
+  worker process:
+    VSZ: 15016/27180 => 45% reduction
+    RSS: 17904/30172 => 41% reduction
+
+That's a major difference, as a 41% reduction in memory footprint means you can host 68% more workers in the same amount of memory.  It also makes your applications faster. They will start faster because zozo loads all necessary library files into a single directory tree.  They will run faster as there will be fewer ruby objects to check every time the garbage collector is run.
+
+= Why?
+
+Rubygems is a fine package distribution system, but it is not very efficient from a runtime memory standpoint.  If your application uses rubygems in production, every time it starts, rubygems needs to figure out which packages to load.  zozo makes it so that this is calculation is only done once, and the result is cached into a local directory.
+
+= How?
+
+zozo works by starting ruby and checking the current load path.  It then requires all of the command line arguments given, and checks the load path again.  Any new entries in the load path are checked and their contents are loaded into a local directory (lib by default).  By default, zozo uses symlinks, but it can use hard links (-H) or make copies (-c) via a command line option.
+
+In addition, new entries in the load path that end in /bin are loaded into a separate local directory (bin by default).  This allows you to run them with loading rubygems via:
+
+  ruby -I lib bin/$program
+
+zozo adds replacement rubygems.rb, ubygems.rb, and bundler.rb files to the lib directory it creates, so it works transparently if your program requires rubygems and/or bundler.  If you run your program without adding the lib directory zozo creates to the load path, rubygems/bundler will be used as it was.  If you run your program with the lib directory zozo creates in the load path, then rubygems/bundler will not be loaded, and it won't need to be because all other libraries your program uses will already be in the load path.
+
+= Where?
+
+http://github.com/jeremyevans/zozo
+
+= Who?
+
+Jeremy Evans / code@jeremyevans.net
+
+= When?
+
+Now:
+
+  sudo gem install zozo
+
+= Does not work with Rails!
+
+The replacement rubygems.rb and bundler.rb files only do the bare minimum.  The rubygems.rb file adds Kernel#gem, and the bundler.rb file adds Bundler.setup, both of which are defined to do nothing and return nil.  No other features are mocked out.  This means that frameworks that rely on introspecting the running Gem/Bundler configuration (notably Rails) will not work.
+
+This is probably fixable, and I'll accept patches that allow zozo to work with Rails, but I don't plan on working on the issue myself.  As Rails uses a substantial amount of memory by itself, it benefits less from zozo than more memory friendly frameworks such as Sinatra.

data/bin/zozo

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+
+# bin/zozo is currently a completely procedural program, with
+# no classes or methods defined.  This may change in the future
+# if more extensibility is desired.
+
+require 'optparse'
+require 'find'
+require 'fileutils'
+
+sep = File::SEPARATOR
+lib_dir = 'lib'
+bin_dir = 'bin'
+ln_method = :ln_s
+ln_opts = {}
+loads = []
+rackups = []
+
+# Parse all command line options
+opt_parser = OptionParser.new do |o|
+  o.banner = "zozo: Simple $LOAD_PATH management for ruby projects"
+  o.define_head "Usage: zozo [-l lib_dir] [-b bin_dir] [-L path] [-R ru_file] [-cfhHnv] lib"
+  o.separator ""
+  o.separator "zozo creates a directory with symbolic links to other directories"
+  o.separator "and files, allowing you to avoid loading rubygems and bundler when"
+  o.separator "running in production with a simple addition of one directory to the"
+  o.separator "$LOAD_PATH."
+  o.separator ""
+  o.separator "Options:"
+
+  o.on("-b", '--bin-dir LIBDIR', "Use a nonstandard bin dir (default: bin)") do |v|
+    bin_dir = v
+  end
+
+  o.on("-c", '--copy', "Copy files instead of creating symbolic links") do
+    ln_method = :cp
+  end
+
+  o.on("-f", '--force', "Force file system modifications") do
+    ln_opts[:force] = true
+  end
+
+  o.on("-h", "-?", "--help", "Show this message and exit") do
+    puts o
+    exit
+  end
+
+  o.on("-H", '--hard-link', "Create hard links instead of symbolic links") do
+    ln_method = :ln
+  end
+
+  o.on("-l", '--lib-dir LIBDIR', "Use a nonstandard lib dir (default: lib)") do |v|
+    lib_dir = v
+  end
+
+  o.on("-L", '--load path', "Use load instead of require for the given argument") do |v|
+    loads << v
+  end
+
+  o.on("-n", '--noop', "Don't make any file system modifications") do
+    ln_opts[:noop] = true
+  end
+
+  o.on("-R", '--rackup ru_file', "Load the given file as a rackup file") do |v|
+    rackups << v
+  end
+
+  o.on("-v", '--verbose', "Log all file system modifications to stderr") do
+    ln_opts[:verbose] = true
+  end
+end
+opt_parser.parse!
+mkdir_opts = ln_opts.reject{|k,v| k == :force}
+
+# Require/load the files specifying by the arguments, and check for new
+# load path entries
+start_dirs = $LOAD_PATH.dup
+ENV['ZOZO'] = '1'
+loads.each{|f| load f}
+unless rackups.empty?
+  begin
+    require 'rack'
+  rescue LoadError
+    require 'rubygems'
+    require 'rack'
+  end
+  rackups.each{|f| eval("Rack::Builder.new{( " + File.read(f) + "\n )}.to_app", nil, f)}
+end
+ARGV.each{|f| require f}
+new_dirs = ($LOAD_PATH - start_dirs).uniq
+
+# Find all files/directories that we want to link to/create
+lns = {}
+bins = {}
+new_dirs.each do |d|
+  Find.find(d) do |f|
+    next if f == d
+    p = f.sub(d, '').sub(sep, '')
+    h = (d =~ /#{sep}bin\z/) ? bins : lns
+    if File.directory?(f)
+      raise(StandardError, "File/directory overlap (file: #{h[p]}, directory: #{f})") if h[p].is_a?(String)
+      h[p] = :dir
+    elsif File.file?(f)
+      raise(StandardError, "File/directory overlap (file: #{f}, directory: #{p})") if h[p] == :dir
+      # Other entry comes before this one in the load path, so ignore it
+      h[p] ||= f
+    end
+  end
+end
+
+# Handle directory creation and file linking/copying
+[[lib_dir, lns], [bin_dir, bins]].each do |dir, h|
+  FileUtils.mkdir(dir, mkdir_opts)
+  h.sort.each do |k, v|
+    p = File.join(dir, k)
+    if v == :dir
+      FileUtils.mkdir(p, mkdir_opts)
+    else
+      FileUtils.send(ln_method, v, p, ln_opts)
+    end
+  end
+end
+
+# Create special files for rubygems and bundler
+%w'rubygems.rb ubygems.rb bundler.rb'
+[['rubygems.rb', "module Kernel; def gem(*args); end end"],
+['ubygems.rb', "require 'rubygems'"],
+['bundler.rb', "module Bundler; def self.setup(*args); end end"]
+].each do |file, data|
+  p = File.join(lib_dir, file)
+  $stderr.puts("Writing #{p}") if ln_opts[:verbose]
+  if ln_opts[:force] || !File.exist?(p)
+    File.open(p, 'wb'){|f| f.puts(data)} unless ln_opts[:noop]
+  end
+end

data/spec/zozo_spec.rb

@@ -0,0 +1,254 @@
+#!/usr/bin/env spec
+
+require 'fileutils'
+require 'open3'
+Dir.chdir(File.dirname(File.expand_path(__FILE__)))
+
+context "zozo" do
+  after do
+    FileUtils.rm_r('lib') if File.directory?('lib')
+    FileUtils.rm_r('bin') if File.directory?('bin')
+  end
+
+  def run(args='test1')
+    `#{File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'bin', 'zozo')} #{args}`
+  end
+
+  def run3(args='test1', &block)
+    Open3.popen3("#{File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'bin', 'zozo')} #{args}", &block)
+  end
+
+  def ino(f)
+    File.stat(f).ino
+  end
+
+  def should_be_same(f1, f2)
+    File.read(f1).should == File.read(f2)
+  end
+
+  it "should create bin and lib directories with symbolic links by default" do
+    run.should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_true
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_true
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_true
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_true
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should print out help if -h option is used" do
+    run('-h').should =~ /Usage: zozo/
+  end
+
+  it "should create bin and lib directories with hard links if the -H option is used" do
+    run('-H test1').should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_false
+    ino('lib/a').should == ino('test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_false
+    ino('lib/b/c').should == ino('test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_false
+    ino('bin/b1').should == ino('b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_false
+    ino('bin/d/b2').should == ino('b/bin/d/b2')
+  end
+
+  it "should create bin and lib directories with file copies if the -c option is used" do
+    run('-c test1').should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_false
+    ino('lib/a').should_not == ino('test1/a')
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_false
+    ino('lib/b/c').should_not == ino('test1/b/c')
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_false
+    ino('bin/b1').should_not == ino('b/bin/b1')
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_false
+    ino('bin/d/b2').should_not == ino('b/bin/d/b2')
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should load files with load instead of require if the -L option is used" do
+    run3('load_test') do |si, so, se|
+      se.read.should =~ /no such file to load -- load_test \(LoadError\)/
+      so.read.should == ''
+    end
+    run('-L load_test').should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_true
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_true
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_true
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_true
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should load rackup files with Rack::Builder instead of require if the -R option is used" do
+    run3('test.ru') do |si, so, se|
+      se.read.should =~ /no such file to load -- test.ru \(LoadError\)/
+      so.read.should == ''
+    end
+    run('-R test.ru').should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_true
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_true
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_true
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_true
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should not make any file system modifications if -n option is used" do
+    run('-n test1').should == ''
+    File.exist?('lib').should be_false
+    File.exist?('bin').should be_false
+  end
+
+  it "should force file system modifications over existing files if -f option is used" do
+    run.should == ''
+    run3 do |si, so, se|
+      se.read.should =~ %r{File exists - /data/code/zozo/spec/test1/a or lib/a \(Errno::EEXIST\)}
+      so.read.should == ''
+    end
+    run('-f test1').should == ''
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_true
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_true
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_true
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_true
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should log all file system modifications to stderr if -v option is used" do
+    run3('-v test1') do |si, so, se|
+      se.read.split("\n").should == ["mkdir lib", "ln -s /data/code/zozo/spec/test1/a lib/a", "mkdir lib/b", "ln -s /data/code/zozo/spec/test1/b/c lib/b/c", "mkdir bin", "ln -s /data/code/zozo/spec/b/bin/b1 bin/b1", "mkdir bin/d", "ln -s /data/code/zozo/spec/b/bin/d/b2 bin/d/b2", "Writing lib/rubygems.rb", "Writing lib/ubygems.rb", "Writing lib/bundler.rb"]
+      se.read.should == ''
+    end
+    File.file?('lib/a').should be_true
+    File.symlink?('lib/a').should be_true
+    should_be_same('lib/a', 'test1/a')
+    File.directory?('lib/b').should be_true
+    File.file?('lib/b/c').should be_true
+    File.symlink?('lib/b/c').should be_true
+    should_be_same('lib/b/c', 'test1/b/c')
+
+    File.file?('bin/b1').should be_true
+    File.symlink?('bin/b1').should be_true
+    should_be_same('bin/b1', 'b/bin/b1')
+    File.directory?('bin/d').should be_true
+    File.file?('bin/d/b2').should be_true
+    File.symlink?('bin/d/b2').should be_true
+    should_be_same('bin/d/b2', 'b/bin/d/b2')
+  end
+
+  it "should handle rubygems' gem method correctly" do
+    run
+    `ruby -I lib test_rubygems.rb`.should == 'no_error'
+  end
+
+  it "should handle requiring rubygems as ubygems" do
+    run
+    `ruby -I lib test_ubygems.rb`.should == 'no_error'
+  end
+
+  it "should handle bundler's Bundler.setup method correctly" do
+    run
+    `ruby -I lib test_bundler.rb`.should == 'no_error'
+  end
+
+  it "should raise an error on file/directory overlap, with directory after file" do
+    run3('test2') do |si, so, se|
+      se.read.should =~ %r{File/directory overlap \(file: .*/zozo/spec/test2/b, directory: .*/zozo/spec/test1/b\) \(StandardError\)}
+      so.read.should == ''
+    end
+  end
+
+  it "should raise an error on file/directory overlap, with file after directory" do
+    run3('test3') do |si, so, se|
+      se.read.should =~ %r{File/directory overlap \(file: .*/zozo/spec/test2/b, directory: b\) \(StandardError\)}
+      so.read.should == ''
+    end
+  end
+
+  it "should define ZOZO environment variable when running under zozo" do
+    run('test_zozo').should == 'no_error'
+  end
+end
+
+context "zozo -b and -l arguments" do
+  after do
+    FileUtils.rm_r('li')
+    FileUtils.rm_r('bi')
+  end
+
+  def should_be_same(f1, f2)
+    File.read(f1).should == File.read(f2)
+  end
+
+  it "should create bin and lib directories with given names" do
+    `#{File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'bin', 'zozo')} -b bi -l li test1`
+    File.file?('li/a').should be_true
+    File.symlink?('li/a').should be_true
+    should_be_same('li/a', 'test1/a')
+    File.directory?('li/b').should be_true
+    File.file?('li/b/c').should be_true
+    File.symlink?('li/b/c').should be_true
+    should_be_same('li/b/c', 'test1/b/c')
+
+    File.file?('bi/b1').should be_true
+    File.symlink?('bi/b1').should be_true
+    should_be_same('bi/b1', 'b/bin/b1')
+    File.directory?('bi/d').should be_true
+    File.file?('bi/d/b2').should be_true
+    File.symlink?('bi/d/b2').should be_true
+    should_be_same('bi/d/b2', 'b/bin/d/b2')
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: zozo
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: code@jeremyevans.net
+executables: 
+- zozo
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- bin/zozo
+files: 
+- README.rdoc
+- LICENSE
+- bin/zozo
+- spec/zozo_spec.rb
+has_rdoc: true
+homepage: http://github.com/jeremyevans/zozo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --line-numbers
+- --inline-source
+- --title
+- "zozo: Simple $LOAD_PATH management for ruby projects"
+- --main
+- README.rdoc
+require_paths: 
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple $LOAD_PATH management for ruby projects
+test_files: 
+- spec/zozo_spec.rb