isolate-lockdown 0.3.0

data/Isolate

@@ -0,0 +1 @@
+gem 'isolate'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Luis Lavena.
+
+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.textile

@@ -0,0 +1,75 @@
+h1. Isolate-Lockdown
+
+* "github.com/luislavena/isolate-lockdown":https://github.com/luislavena/isolate-lockdown
+
+h2. Description
+
+Isolate-Lockdown extends Isolate sandbox behavior with the goal of generating a monolithic directory to reduce startup time of your application.
+
+h2. What?
+
+Having several gems in Ruby's @$LOAD_PATH@ results in slow require. The more bigger your application (with more gems), the longer it will take to start up.
+
+On Rails applications, you can see this performance problem once you deploy a new version of code to your server. When the application restart, it can take several seconds to respond to the first request.
+
+h2. Requirements
+
+Isolate, RubyGems and Rake (only for extraction)
+
+h2. How to use it
+
+Isolate-lockdown provides a rake task that allow easy execution from command line.
+
+These instructions assume you already followed Isolate "instructions":https://github.com/jbarnette/isolate for using Isolate in your application.
+
+h3. Depend on @isolate-lockdown@
+
+Since you're using Isolate, you need to define your dependency on this extension, please add it:
+
+bc. gem 'isolate-lockdown'
+
+After that, early in your application Rakefile (after @isolate/now@)
+
+bc. require 'isolate/lockdown'
+
+h3. Using @isolate:lockdown@
+
+Previous step will make available @isolate:lockdown@ rake task:
+
+bc. rake isolate:lockdown[folder]  # Lockdown isolated gems into folder (defaults 'tmp/lockdown')
+
+Once you execute @isolate:lockdown@, it will extract your gems contents into the specified _folder_, also generating @paths.rb@ file that will look something like this:
+
+bc. $:.unshift File.expand_path("tmp/lockdown/lib")
+
+h3. Using the lockdown gems in your application
+
+Now, you need to adapt the startup process of your application to use this generate file.
+
+The following is a simple Rails 3 example:
+
+bc.. lockdown = File.expand_path('../../tmp/lockdown/paths.rb', __FILE__)
+unless File.exist?(lockdown)
+  # using Isolate (development)
+  require 'isolate/now'
+  require 'isolate/lockdown'
+else
+  # using the lockdown (production)
+  require lockdown
+end
+
+h3. Avoid executing during development
+
+Please remember that lockdown is aimed to be used or executed during deployment and should not be used during development, as it removes Isolate and itself from the equation.
+
+Not depending on Isolate will render any update to your gem manifest (Isolate) useless. Prior reporting bugs, please remove @tmp/lockdown@ directory and try again.
+
+h2. License
+
+Copyright (c) 2010 Luis Lavena.
+
+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/Rakefile

@@ -0,0 +1,50 @@
+# prepend lib directory
+$:.unshift File.expand_path('lib', File.dirname(__FILE__))
+
+begin
+  require 'isolate/now'
+rescue LoadError
+  abort "This project requires Isolate to work, please 'gem install isolate' first."
+end
+
+require 'isolate/lockdown'
+require 'rubygems/package_task'
+
+GEM_SPEC = Gem::Specification.new do |s|
+  # basic information
+  s.name    = 'isolate-lockdown'
+  s.version = '0.3.0'
+  s.platform = Gem::Platform::RUBY
+
+  # description and details
+  s.summary     = 'Lockdown your isolated gems, give them speed.'
+  s.description = "Extension for Isolate that extracts dependent gem contents\ninto a single, monolithic directory to reduce Ruby load time."
+
+  # requirements
+  s.required_ruby_version = ">= 1.8.6"
+  s.required_rubygems_version = ">= 1.3.7"
+
+  # dependencies
+  s.add_dependency  'isolate'
+
+  # components, files and paths
+  s.files = FileList["lib/**/*.rb", "Rakefile", "Isolate", "*.{textile,txt}"]
+
+  s.require_path = 'lib'
+
+  # documentation
+  s.has_rdoc = false
+
+  # project information
+  s.homepage          = 'http://github.com/luislavena/isolate-lockdown'
+  s.licenses          = ['MIT']
+
+  # author and contributors
+  s.author      = 'Luis Lavena'
+  s.email       = 'luislavena@gmail.com'
+end
+
+Gem::PackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end

data/lib/isolate/lockdown.rb

@@ -0,0 +1,20 @@
+require 'isolate'
+require 'isolate/lockdown/rake' if defined?(Rake)
+
+module Isolate::Lockdown
+  # Adapt from Isolate own source code
+  def legitimize!(deps)
+    specs = []
+
+    deps.flatten.each do |dep|
+      spec = Gem.source_index.find_name(dep.name, dep.requirement).last
+
+      if spec
+        specs.concat legitimize!(spec.runtime_dependencies)
+        specs << spec
+      end
+    end
+
+    specs.uniq
+  end
+end

data/lib/isolate/lockdown/rake.rb

@@ -0,0 +1,84 @@
+namespace :isolate do
+  desc "Lockdown isolated gems into folder (defaults 'tmp/lockdown')"
+  task :lockdown, [:folder] do |t, args|
+    include Isolate::Lockdown
+
+    args.with_defaults(:folder => 'tmp/lockdown')
+
+    folder = args.folder
+    safe_folder = "#{folder}.safe"
+    temp_folder = "#{folder}.#{$$}"
+    loader_script = File.join(folder, 'paths.rb')
+
+    # remove previous safe folder if exists
+    when_writing "Removing previous safe folder" do
+      FileUtils.rm_rf safe_folder if File.exist?(safe_folder)
+    end
+
+    # collect entries valid for current environment
+    entries = Isolate.sandbox.entries.find_all { |e| e.matches?(Isolate.env) }
+
+    # determine which specs are really needed
+    specs = legitimize!(entries)
+
+    # collect gem lib dir to be used for require
+    require_paths = []
+
+    specs.each do |spec|
+      $stdout.puts "Locking down #{spec.name} #{spec.version}" if
+        Rake.application.options.trace
+
+      base = spec.full_gem_path
+
+      spec.add_bindir(spec.executables).each do |exe|
+        bin_dir = File.join(temp_folder, 'bin')
+        full_exe = File.join(base, exe)
+
+        FileUtils.mkdir_p(bin_dir) unless File.exist?(bin_dir)
+        FileUtils.cp full_exe, bin_dir
+      end
+
+      spec.require_paths.each do |path|
+        # do not add bindir to load path
+        next if path == spec.bindir
+
+        lib_dir = File.join(temp_folder, path)
+        require_paths << File.join(folder, path)
+
+        FileUtils.mkdir_p(lib_dir)
+
+        glob = File.join(base, path, '*')
+        Dir.glob(glob).each do |full_lib|
+          if File.file?(full_lib)
+            FileUtils.cp(full_lib, lib_dir)
+          else
+            FileUtils.cp_r(full_lib, lib_dir)
+          end
+        end
+      end
+
+      # show some progress with big list of gems
+      unless Rake.application.options.trace
+        $stdout.print "."
+        $stdout.flush
+      end
+    end
+
+    FileUtils.mv(folder, safe_folder) if File.exist?(folder)
+
+    # Avoid permission denied issues under Windows
+    sleep(1) if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+
+    FileUtils.mv(temp_folder, folder)
+
+    when_writing("Updating #{loader_script}") do
+      File.open(loader_script, 'w') do |f|
+        require_paths.uniq.each do |path|
+          f.puts "$:.unshift File.expand_path(#{path.inspect})"
+        end
+      end
+    end
+
+    $stdout.puts
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: isolate-lockdown
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Luis Lavena
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-24 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: isolate
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |-
+  Extension for Isolate that extracts dependent gem contents
+  into a single, monolithic directory to reduce Ruby load time.
+email: luislavena@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/isolate/lockdown/rake.rb
+- lib/isolate/lockdown.rb
+- Rakefile
+- Isolate
+- README.textile
+- LICENSE.txt
+has_rdoc: true
+homepage: http://github.com/luislavena/isolate-lockdown
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Lockdown your isolated gems, give them speed.
+test_files: []
+