frozen_gems_generator 0.4.0

data/History.txt

@@ -0,0 +1,7 @@
+=== 0.4.0 / 2008-03-03
+
+* conversion from plugin to gem
+
+=== 0.3.0 / 2008-02-29
+
+* first public release

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+ToDo.txt
+generators/frozen_gems/USAGE
+generators/frozen_gems/frozen_gems_generator.rb
+generators/frozen_gems/templates/gem
+generators/frozen_gems/templates/gems.rb
+test/test_frozen_gems_generator.rb

data/README.txt

@@ -0,0 +1,81 @@
+= frozen_gems_generator
+
+http://opensource.thinkrelevance.com/wiki/FrozenGemsGenerator
+
+== DESCRIPTION:
+
+The frozen_gems generator gives your Rails application its own
+private gem library, in vendor/gems, and a script/gem command for
+managing that library.
+
+To enable, run
+
+    script/generate frozen_gems
+
+Scripts and tasks that load environment.rb will have access to the
+application's gem library.  Gems in the system-wide gem library are
+still accessible to your app, but gems in the private library will
+be found first.  (One consequence of this is that 'script/gem list'
+will show all of the gems installed in both libraries.)
+
+== FEATURES/PROBLEMS:
+
+Gems that have binary components install the binary components in
+the system-wide Ruby lib directories. Thus, when such gems are
+frozen and deployed, they  will be incomplete. I recommend that you
+install such gems  in the system-wide gem library on development
+machines and the deployment machine alike. Suggestions  for a
+satisfactory solution to this problem are welcome.
+
+== SYNOPSIS:
+
+To manage your app's gems, use the script/gem command (which is
+just a wrapper for the standard gem command and uses the same
+syntax).  For example:
+
+    $ script/gem install xml-simple
+    Executing 'gem install' with --no-rdoc and --no-ri options
+	Bulk updating Gem source index for: http://gems.rubyforge.org
+	Successfully installed xml-simple-1.0.11
+
+Gems are installed without RDoc and ri documentation; other than
+that, the behavior should be the same as the standard gem command.
+(Due to a bug in some versions of RubyGems, the first attempted
+installation may fail; subsequent attempts should succeed.)
+
+== REQUIREMENTS:
+
+FrozenGems assumes Rails 2.0 or greater, due to its dependency on
+preinitializer.rb.  If you're using an earlier version of Rails,
+you can copy the contents of config/preinitializer.rb into
+config/environment.rb, just prior to the call to Rails::Initializer.run.
+
+== INSTALL:
+
+* sudo gem install frozen_gems_generator
+* script/generate frozen_gems
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Glenn Vanderburg
+
+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,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+gem 'rails'
+require 'rails_generator'
+require 'generators/frozen_gems/frozen_gems_generator.rb'
+
+Hoe.new('frozen_gems_generator', FrozenGemsGenerator::VERSION) do |p|
+  p.rubyforge_name = 'thinkrelevance'
+  p.author = 'Glenn Vanderburg'
+  p.email = ['glenn@thinkrelevance.com', 'glv@vanderburg.org']
+  p.summary = 'Application-specific gem libraries for Rails projects.'
+  p.description = p.paragraphs_of('README.txt', 3..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 1).first.split(/\n/)[0]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps = %w{rails}
+  p.spec_extras = {
+    :require_paths => ['generators/frozen_gems'],
+    :has_rdoc => false
+  }
+end
+
+# vim: syntax=Ruby

data/ToDo.txt

@@ -0,0 +1,2 @@
+* handle gems with binary components
+* add --frozen option (analogous to --local) to restrict operations to *only* the frozen repository.

data/generators/frozen_gems/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Installs and patches files to provide a frozen, application-specific gem library.
+
+Example:
+    ./script/generate frozen_gems
+
+    This will create:
+        script/gem
+        config/gems.rb
+
+    and create or patch (as necessary):
+        config/preinitializer.rb

data/generators/frozen_gems/frozen_gems_generator.rb

@@ -0,0 +1,81 @@
+class FrozenGemsGenerator < Rails::Generator::Base
+  VERSION = '0.4.0'
+  
+  def manifest
+    record do |m|
+      m.file 'gem', 'script/gem', :chmod => 0755, :shebang => '/usr/bin/env ruby'
+      m.file 'gems.rb', 'config/gems.rb'
+      
+      m.preinitialize <<-EOFRAG
+# Before plugins get loaded, activate FrozenGems private gem library
+require 'rubygems'
+require File.join(File.dirname(__FILE__), 'gems')
+      EOFRAG
+    end
+  end
+end
+
+require 'rails_generator/simple_logger'
+
+module Rails
+  module Generator    
+    module Commands
+      
+      class Base
+        protected
+                
+        def match_in_file(file, regexp)
+          File.read(file) =~ regexp
+        end
+      end
+      
+      class Create
+        def preinitialize(fragment)
+          pre_path = "config/preinitializer.rb"
+          full_path = destination_path(pre_path)
+          destination_exists = File.exists?(full_path)
+          
+          if destination_exists && match_in_file(full_path, /(#{Regexp.escape(fragment)})/mi)
+            logger.exists "#{pre_path} (patch)"
+            return
+          elsif destination_exists
+            logger.patch pre_path
+          else
+            logger.create pre_path
+          end
+          unless options[:pretend]
+            File.open(full_path, "w+") do |pre_file|
+              pre_file.puts
+              pre_file.puts fragment
+            end
+          end
+        end
+      end
+      
+      class Destroy
+        def preinitialize(fragment)
+          pre_path = "config/preinitializer.rb"
+          full_path = destination_path(pre_path)
+          patch_re = /(#{Regexp.escape(fragment)})/mi
+          
+          if File.exists?(full_path) && match_in_file(full_path, patch_re)
+            logger.unpatch pre_path
+          else 
+            logger.skip pre_path
+            return
+          end
+
+          gsub_file pre_path, patch_re, ''
+        end
+      end
+      
+      class List
+        def preinitialize(fragment)
+          resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+          logger.preinit "config/preinitializer.rb (patch)"
+        end
+      end
+      
+    end
+  end
+end

data/generators/frozen_gems/templates/gem

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# Part of FrozenGems
+FROZEN_GEMS_SCRIPT_GEM = true
+
+require File.dirname(__FILE__) + '/../config/gems'
+args = ARGV.dup
+args.each_with_index do |arg, i|
+  unless arg =~ /^-/  # find subcommand
+    if arg =~ /^(install|update)$/
+      args.insert(i+1, '--no-rdoc', '--no-ri')
+      puts "Executing 'gem #{$1}' with --no-rdoc and --no-ri options"
+    end
+    break
+  end
+end
+
+system('gem', *args)

data/generators/frozen_gems/templates/gems.rb

@@ -0,0 +1,23 @@
+# Part of FrozenGems
+local_gem_repos = File.expand_path(File.dirname(__FILE__) + '/../vendor/gems')
+
+gems_loaded = Gem::RubyGemsVersion rescue false
+
+if Object.const_defined? :FROZEN_GEMS_SCRIPT_GEM || !gems_loaded
+  sep = File::PATH_SEPARATOR
+  existing_gem_path = `gem environment gempath`.chomp.gsub($/, sep)
+  ENV['GEM_HOME'] = local_gem_repos
+  ENV['GEM_PATH'] = local_gem_repos + sep + existing_gem_path
+else
+  paths = Gem.path.dup
+  paths.insert(0, local_gem_repos)
+  Gem.use_paths local_gem_repos, paths
+  module Gem
+    def self.reset_searcher
+      MUTEX.synchronize do
+        @searcher = nil
+      end
+    end
+  end
+  Gem.reset_searcher
+end

data/test/test_frozen_gems_generator.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class TestFrozenGemsGenerator < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_generator
+    flunk
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: frozen_gems_generator
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+platform: ruby
+authors: 
+- Glenn Vanderburg
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDRDCCAiygAwIBAgIBADANBgkqhkiG9w0BAQUFADBIMQ4wDAYDVQQDDAVnbGVu
+  bjEeMBwGCgmSJomT8ixkARkWDnRoaW5rcmVsZXZhbmNlMRYwFAYKCZImiZPyLGQB
+  GRYGY29tZ2x2MB4XDTA4MDMwNDIwNDIzNFoXDTA5MDMwNDIwNDIzNFowSDEOMAwG
+  A1UEAwwFZ2xlbm4xHjAcBgoJkiaJk/IsZAEZFg50aGlua3JlbGV2YW5jZTEWMBQG
+  CgmSJomT8ixkARkWBmNvbWdsdjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBALXdD5Y00ZMPO/dL8sj1IcfomhezB+9rsO/FoCnR9TJyaOGPBAJBEfyA3SkP
+  hpbCkkUDpNlRR2sQHrtqBJovpw2oX6zakrG8PnDQQPU1oo0tWkiDtPFQc9lgDJOA
+  S/nQiS2D9rusOmpj84KpC6DUN80M+ap9z04Xadobuv7Cer/dTOfs4skUBiN/aonA
+  qtaRNOlOPGyPGiCa8tUQd53fVml2hSKIgt/+HfBHHWZkHs9UQRsqd7GICFi5R24i
+  ZNXbaRzw4637eCcjBhlEes9KMJOwayZ1KXHWzOdSzRJUI6nT4AQjw3GCyuXBmCY0
+  LFrbGOLYuqfiv/zr+Z+qqyI3Ul0CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8E
+  BAMCBLAwHQYDVR0OBBYEFOsd6jtw384ogcRecKkFdFpm9SQkMA0GCSqGSIb3DQEB
+  BQUAA4IBAQBokYH6Pe63OU1O9t4z6jEom2NDieUlLWD9PTshI4UXUjxd83mjmg/Y
+  Cer/yqFHqQEW6BLNRmH6l2lw2Rb8CZdlh7K8Q8F/94M+actty2UvMgTyVEtOnyh/
+  QU8nqEil5vl7ppCwDeSF32cebsQoimkgAamOxVZVe5ipP1+UIO+Eu92Jt5k0hrnd
+  1Fz3W+wrffm45P2X/6Z36dXgZKn8dlHuYtsqgpQxBC92oE7UqHXvwAu3FFe+1EV7
+  LrV1pr2EyieDotJOooYNz/E+9ZeL14MBhDOVmPr4KHTTK4VwdxFtAKu2QK/NfAAl
+  zrNa6ECLh1VS/pV78rYbAO1ZXsg3l7bY
+  -----END CERTIFICATE-----
+
+date: 2008-03-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: The frozen_gems generator gives your Rails application its own private gem library, in vendor/gems, and a script/gem command for managing that library.  To enable, run  script/generate frozen_gems
+email: 
+- glenn@thinkrelevance.com
+- glv@vanderburg.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- ToDo.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- ToDo.txt
+- generators/frozen_gems/USAGE
+- generators/frozen_gems/frozen_gems_generator.rb
+- generators/frozen_gems/templates/gem
+- generators/frozen_gems/templates/gems.rb
+- test/test_frozen_gems_generator.rb
+has_rdoc: false
+homepage: http://opensource.thinkrelevance.com/wiki/FrozenGemsGenerator
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- generators/frozen_gems
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thinkrelevance
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Application-specific gem libraries for Rails projects.
+test_files: 
+- test/test_frozen_gems_generator.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+�&
|^��-Q�^���;rp�H�v��˥�V�r:�[B�m�PVW����o�(�ϔ�pܭ�?Ow�	
�:98�	ق4������$v�}�EN�CV
+B�^�	c�w�w��I�Q�������=ְ�J~ܪ��Ik�k�Se��hF�_��z@]�Ʈ���-O{=&�Ck�J=CN�t��YJ��?��U���|�X�