torquebox-rake-support 2.1.2 → 2.2.0

data/lib/torquebox/deploy_utils.rb

@@ -159,42 +159,115 @@ module TorqueBox
           ENV.delete('BUNDLE_GEMFILE')
           # If called from rake within a rails app, bundler will try
           # to init itself via RUBYOPT, which we don't want
-          ENV.delete('RUBYOPT') 
-          # Match load-path of booted TorqueBox to the load-path of
-          # this process so that we know we can find bundler and our
-          # own gems if used with bundle install --deployment
-          ENV['RUBYLIB'] = "#{ENV['RUBYLIB']}:#{$:.join(':')}"
-
-          set_java_opts("#{options[:jvm_options]} #{jruby_opts_properties}")
+          ENV.delete('RUBYOPT')
+          # Ensure bundler gets on the Ruby load path of the booted
+          # TorqueBox instance if it's on the load path of this Ruby
+          # runtime so we can find bundler and our own gems if used
+          # with bundle install --deployment
+          ENV['RUBYLIB'] = rubylib_with_bundler($:)
+
+          options[:jvm_options] ||= ''
+          options[:jvm_options] << " #{jruby_opts_properties}"
+          options[:jvm_options] << " #{strip_jvm_properties_from_jruby_opts}"
+
+          set_java_opts(options[:jvm_options].strip)
           print_server_config(options[:clustered])
           exec_command(run_command_line(options).join(' '))
         end
       end
 
+      # name: (string) what to call the resulting knob file
+      # app_dir: (string) where the application to be packaged is
+      # dest_dir: (string) where to put the resulting knob file
+      # excludes: (string) string or regex of files to exclude from the archive
+      # precompile_assets: (boolean) whether or not to precompile assets. this is rails-specific.
+      # package_gems: (boolean) whether or not to install all bundle gems to vendor/bundle (this
+      #                         is rather convenient as it means that you don't have to run bundle
+      #                         install on your production servers)
+      # package_without: (array) all the bundler groups to run bundle install without (cuts down
+      #                          on package size by snipping out potentially inappropriate
+      #                          dependencies for a production environment).
       def create_archive(opts = {})
-
         archive = normalize_archive_name( find_option( opts, 'name' ) || archive_name )
-        app_dir = find_option( opts, 'app_dir') || Dir.pwd
-        dest_dir = find_option( opts, 'dest_dir') || Dir.pwd
+        app_dir = find_option( opts, 'app_dir' ) || Dir.pwd
+        dest_dir = find_option( opts, 'dest_dir' ) || Dir.pwd
+        excludes = find_option( opts, 'exclude' ) || ""
+        should_precompile_assets = find_option( opts, 'precompile_assets' ) == true
+        should_package_gems = find_option( opts, 'package_gems' ) == true
+        package_without = find_option( opts, 'package_without' ) || Array.new
+
+        if should_precompile_assets
+          precompile_assets( app_dir )
+          raise 'Error precompiling assets' unless $? == 0
+        end
+
+        archive_path = File.join( dest_dir, archive )
+        archive_proc = lambda { create_knob_archive( app_dir, archive_path, excludes ) }
+
+        if should_package_gems
+          package_gems( app_dir, package_without ) {
+            raise 'Error packaging gems' unless $? == 0
+            archive_proc.call
+          }
+        else
+          archive_proc.call
+        end
+
+        archive_path
+      end
+
+      def precompile_assets(app_dir)
+        Dir.chdir( app_dir ) do
+          jruby_command( "-S rake assets:precompile" )
+        end
+      end
+
+      def package_gems(app_dir, package_without)
+        # note - this is used instead of freeze gems because it
+        # should cause the archive to capture .bundle/config,
+        # thereby forcing the app to use the bundled gems. we delete
+        # the deployment configuration for rubygems afterward
+        bundler_config = File.join( app_dir, '.bundle/config' )
+        if File.exists?( bundler_config )
+          old_config = File.read( bundler_config )
+        else
+          old_config = nil
+        end
+        cmd = %w{-S bundle install --local --deployment}
+        unless package_without.empty?
+          cmd << '--without'
+          cmd << package_without
+        end
+        Dir.chdir( app_dir ) do
+          jruby_command( '-S bundle package' )
+          jruby_command( cmd.flatten.join(' ') )
+        end
+        yield if block_given?
+      ensure
+        if File.exists?( bundler_config )
+          if old_config
+            File.open( bundler_config, 'w' ) { |io| io.write( old_config ) }
+          else
+            File.delete( bundler_config ) # there wasn't originally a config file there
+          end
+        end
+      end
 
+      def create_knob_archive(app_dir, archive_path, excludes)
         default_skip_files = %w{ ^log/ ^tmp/ ^test/ ^spec/ ^[^/]*\.knob$ vendor/.*cache/.*\.gem$ }
-        opts_skip_files = (find_option(opts, 'exclude') || "").
-          split(/,/).
-          map { |r| "^[^/]*#{r}"}
+        opts_skip_files = excludes.split( /,/ ).map { |r| "^[^/]*#{r}" }
         skip_files = default_skip_files + opts_skip_files
 
-        archive_path = File.join(dest_dir, archive)
-
         Dir.chdir( app_dir ) do
           include_files = []
           Dir[ "**/**", ".bundle/**/**" ].each do |entry|
-            unless File.directory?(entry) || skip_files.any? {|regex| entry.match(regex)}
+            unless File.directory?( entry ) || skip_files.any? { |regex| entry.match( regex ) }
               include_files << '"' + entry.to_s + '"'
             end
           end
 
-          includes = Tempfile.new("include-files")
-          includes.write(include_files.join("\n"))
+          includes = Tempfile.new( "include-files" )
+          includes.write( include_files.join( "\n" ) )
           includes.flush
 
           cmd = "jar cvf '#{archive_path}' @#{includes.path}"
@@ -202,16 +275,12 @@ module TorqueBox
           run_command( cmd )
           includes.close( true )
         end
-
-        archive_path
       end
 
       def freeze_gems(app_dir = Dir.pwd)
         Dir.chdir( app_dir ) do
-          jruby = File.join( RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'] )
-          jruby << " --1.9" if RUBY_VERSION =~ /^1\.9\./
-          run_command( "#{jruby} -S bundle package" )
-          run_command( "#{jruby} -S bundle install --local --path vendor/bundle" )
+          jruby_command( '-S bundle package' )
+          jruby_command( '-S bundle install --local --path vendor/bundle' )
         end
       end
 
@@ -299,6 +368,12 @@ module TorqueBox
         success
       end
 
+      def jruby_command(cmd)
+        jruby = File.join( RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'] )
+        RUBY_VERSION =~ /^1\.9\./ ? jruby << " --1.9" : jruby << " --1.8"
+        run_command( "#{jruby} #{cmd}" )
+      end
+
       def run_command(cmd)
         puts `#{cmd} 2>&1`
       end
@@ -410,10 +485,35 @@ module TorqueBox
         jruby_opts = ENV['JRUBY_OPTS']
         return "" if jruby_opts.nil?
         # Only convert -Xa.b, -Xa.b.c, -Xa.b.c.d style options to properties
-        properties = jruby_opts.scan(/-X(\w+\..+?)\s/)
+        properties = jruby_opts.scan(/-X(\w+\..+?)(\s|$)/)
         properties.map { |matches| "-Djruby.#{matches.first}" }.join(' ')
       end
 
+      def strip_jvm_properties_from_jruby_opts
+        jruby_opts = ENV['JRUBY_OPTS']
+        return '' if jruby_opts.nil?
+        jvm_properties = []
+        properties = jruby_opts.split(' ')
+        properties.each do |property|
+          if property =~ /^-J.+/
+            jvm_properties << property.sub(/-J/, '')
+            ENV['JRUBY_OPTS'] = ENV['JRUBY_OPTS'].sub(property, '')
+          end
+        end
+        # get rid of any leftover spaces
+        ENV['JRUBY_OPTS'] = ENV['JRUBY_OPTS'].split(' ').join(' ')
+        jvm_properties.join(' ')
+      end
+
+      def rubylib_with_bundler(load_path)
+        bundler_load_paths = load_path.select { |p| p.include?('bundler') }
+        rubylib = (ENV['RUBYLIB'] || '').dup # ENV strings are frozen
+        unless rubylib.empty? || bundler_load_paths.empty?
+          rubylib << ':'
+        end
+        rubylib << bundler_load_paths.join(':')
+      end
+
       private
 
       def undeploy(name, opts = {})

data/lib/torquebox/rails.rb

@@ -23,6 +23,7 @@ rescue LoadError
 end
 
 module TorqueBox
+  # @api private
   class Rails
 
     def self.new_app( root )

data/spec/deploy_utils_spec.rb

@@ -251,13 +251,13 @@ describe TorqueBox::DeployUtils do
     end
 
     it 'should set java options' do
-      @util.should_receive(:set_java_opts).with('java options ')
+      @util.should_receive(:set_java_opts).with('java options')
       @util.run_server(:jvm_options => 'java options')
     end
 
     it 'should pass JRUBY_OPTS properties' do
-      ENV['JRUBY_OPTS'] = '--1.9 -Xjit.logging=true -Xthread.pool.enabled=true -X+C'
-      @util.should_receive(:set_java_opts).with(' -Djruby.jit.logging=true -Djruby.thread.pool.enabled=true')
+      ENV['JRUBY_OPTS'] = '--1.9 -Xjit.logging=true -Xthread.pool.enabled=true'
+      @util.should_receive(:set_java_opts).with('-Djruby.jit.logging=true -Djruby.thread.pool.enabled=true')
       @util.run_server
     end
 
@@ -266,6 +266,13 @@ describe TorqueBox::DeployUtils do
       @util.should_receive(:set_java_opts).with('java options -Djruby.jit.logging=true')
       @util.run_server(:jvm_options => 'java options')
     end
+
+    it 'should strip and pass JRUBY_OPTS jvm options' do
+      ENV['JRUBY_OPTS'] = '--1.9 -J-Xmx1024m -J-Xss2048k -Xjit.logging=true'
+      @util.should_receive(:set_java_opts).with('some java options -Djruby.jit.logging=true -Xmx1024m -Xss2048k')
+      @util.run_server(:jvm_options => 'some java options')
+      ENV['JRUBY_OPTS'].should == '--1.9 -Xjit.logging=true'
+    end
   end
 
   describe '.is_deployed?' do
@@ -449,4 +456,35 @@ describe TorqueBox::DeployUtils do
       @util.deployment_status[@appname][:status].should == 'deployment failed'
     end
   end
+
+  describe '.rubylib_with_bundler' do
+    before(:each) do
+      @rubylib = ENV['RUBYLIB']
+    end
+
+    after(:each) do
+      ENV['RUBYLIB'] = @rubylib
+    end
+
+    it 'should equal ENV["RUBYLIB"] if bundler not in load path' do
+      ENV['RUBYLIB'] = '/path/to/somewhere'
+      @util.rubylib_with_bundler([]).should == '/path/to/somewhere'
+    end
+
+    it 'should be empty if ENV["RUBYLIB"] not set and bundler not on load path' do
+      ENV['RUBYLIB'] = nil
+      @util.rubylib_with_bundler([]).should be_empty
+    end
+
+    it 'should not include ENV["RUBYLIB"] if not set' do
+      ENV['RUBYLIB'] = nil
+      @util.rubylib_with_bundler(['/some/bundler/path']).should == '/some/bundler/path'
+    end
+
+    it 'should only include load path entries containing bundler' do
+      ENV['RUBYLIB'] = '/path/to/abc'
+      load_path = ['/some/bundler/path', '/some/other/path']
+      @util.rubylib_with_bundler(load_path).should =='/path/to/abc:/some/bundler/path'
+    end
+  end
 end

metadata

@@ -1,109 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: torquebox-rake-support
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 2.1.2
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 2.2.0
 platform: ruby
-authors: 
-  - The TorqueBox Team
-autorequire: 
+authors:
+- The TorqueBox Team
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2012-09-24 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rake
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.8.7
-        - - <
-          - !ruby/object:Gem::Version 
-            version: 1.0.0
-    type: :runtime
-    version_requirements: *id001
-  - !ruby/object:Gem::Dependency 
-    name: rspec
-    prerelease: false
-    requirement: &id002 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - "="
-          - !ruby/object:Gem::Version 
-            version: 2.7.0
-    type: :development
-    version_requirements: *id002
-description: ""
-email: 
-  - torquebox-dev@torquebox.org
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    none: false
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+    none: false
+  prerelease: false
+  type: :development
+description: ''
+email:
+- torquebox-dev@torquebox.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - licenses/lgpl-2.1.txt
-  - lib/org.torquebox.rake-support.rb
-  - lib/torquebox-rake-support.rb
-  - lib/torquebox/server.rb
-  - lib/torquebox/upstart.rb
-  - lib/torquebox/deploy_utils.rb
-  - lib/torquebox/rails.rb
-  - lib/torquebox/launchd.rb
-  - lib/torquebox/rake/tasks.rb
-  - lib/torquebox/rake/tasks/deployment.rb
-  - lib/torquebox/rake/tasks/server.rb
-  - lib/torquebox/rake/tasks/archive.rb
-  - generators/USAGE
-  - generators/torquebox_queue_generator.rb
-  - generators/templates/queue.rb
-  - spec/spec_helper.rb
-  - spec/server_spec.rb
-  - spec/deploy_utils_spec.rb
-  - spec/upstart_spec.rb
-  - spec/rails_spec.rb
-  - spec/fixtures/simpleapp/simpleapp.box
-  - spec/fixtures/simpleapp/config.ru
-  - spec/fixtures/simpleapp/puppet/puppet.rb
-  - spec/fixtures/simpleapp/app/app.rb
-  - spec/fixtures/simpleapp/app/a-non-cached.gem
-  - spec/fixtures/simpleapp/app/puppet-master.rb
-  - spec/fixtures/simpleapp/app/app.box
-  - spec/fixtures/simpleapp/vendor/vendor.rb
+files:
+- licenses/lgpl-2.1.txt
+- lib/org.torquebox.rake-support.rb
+- lib/torquebox-rake-support.rb
+- lib/torquebox/rails.rb
+- lib/torquebox/deploy_utils.rb
+- lib/torquebox/upstart.rb
+- lib/torquebox/launchd.rb
+- lib/torquebox/server.rb
+- lib/torquebox/rake/tasks.rb
+- lib/torquebox/rake/tasks/deployment.rb
+- lib/torquebox/rake/tasks/archive.rb
+- lib/torquebox/rake/tasks/server.rb
+- generators/USAGE
+- generators/torquebox_queue_generator.rb
+- generators/templates/queue.rb
+- spec/server_spec.rb
+- spec/deploy_utils_spec.rb
+- spec/rails_spec.rb
+- spec/upstart_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures/simpleapp/simpleapp.box
+- spec/fixtures/simpleapp/config.ru
+- spec/fixtures/simpleapp/vendor/vendor.rb
+- spec/fixtures/simpleapp/puppet/puppet.rb
+- spec/fixtures/simpleapp/app/app.box
+- spec/fixtures/simpleapp/app/a-non-cached.gem
+- spec/fixtures/simpleapp/app/app.rb
+- spec/fixtures/simpleapp/app/puppet-master.rb
 homepage: http://torquebox.org/
-licenses: 
-  - lgpl
-post_install_message: 
+licenses:
+- lgpl
+post_install_message:
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
 requirements: []
-
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key: 
+signing_key:
 specification_version: 3
 summary: TorqueBox Rake Support
-test_files: 
-  - spec/server_spec.rb
-  - spec/deploy_utils_spec.rb
-  - spec/upstart_spec.rb
-  - spec/rails_spec.rb
+test_files:
+- spec/server_spec.rb
+- spec/deploy_utils_spec.rb
+- spec/rails_spec.rb
+- spec/upstart_spec.rb