rvm-completion 0.2.0 → 0.2.1

data/README.rdoc

@@ -4,14 +4,25 @@ Provides you with bash completion for the Ruby Version Manager by Wayne Seguin,
 including completion of installed Rubies and available gemsets for currently active
 Ruby.
 
-== Install
+The ruby and gemset name completion also accepts parts of the name via regular
+expression matching, so typing 'rvm use 299' will match to 'rvm use ruby-1.8.7-p299'
+
+== Install via gems
 
   $ gem install rvm-completion
   $ install-rvm-completion
   
 Then add the following line to your bash profile (~/.profile or ~/.bashrc):
+
   complete -C $rvm_scripts_path/rvm-completion.rb -o default rvm
+  
+== Manual install
+
+You can also install manually by grabbing the rvm-completion.rb file inside the lib
+directory, placing it somewhere on your local machine, making it executable with
+chmod +x and adding the following to your bash profile:
 
+  complete -C THE/PATH/TO/rvm-completion.rb -o default rvm
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/rvm-completion.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rvm-completion}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
@@ -29,11 +29,13 @@ Gem::Specification.new do |s|
      "lib/rvm-completion.rb",
      "rvm-completion.gemspec",
      "test/helper.rb",
+     "test/rvm_mock_environment.rb",
+     "test/test_installer.rb",
      "test/test_rvm-completion.rb"
   ]
   s.homepage = %q{http://github.com/colszowka/rvm-completion}
   s.post_install_message = %q{
-To install rvm completion v0.2.0, please run 'install-rvm-completion' in your terminal now!
+To install rvm completion v0.2.1, please run 'install-rvm-completion' in your terminal now!
 
 }
   s.rdoc_options = ["--charset=UTF-8"]
@@ -42,6 +44,8 @@ To install rvm completion v0.2.0, please run 'install-rvm-completion' in your te
   s.summary = %q{bash completion for Ruby Version Manager}
   s.test_files = [
     "test/helper.rb",
+     "test/rvm_mock_environment.rb",
+     "test/test_installer.rb",
      "test/test_rvm-completion.rb"
   ]
 

data/test/helper.rb

@@ -6,41 +6,13 @@ require 'fileutils'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rvm-completion'
-
-# Define path to tmp directory
-tmp_root = File.expand_path(File.join(File.dirname(__FILE__), '../tmp'))
-
-# Set environment vars used in completion to test-specific ones
-ENV['rvm_rubies_path'] = File.join(tmp_root, 'rubies')
-ENV['rvm_gems_path'] = File.join(tmp_root, 'gems')
-ENV['rvm_gemset_separator'] = '@'
-
-# Clean up and prepare test folders
-FileUtils.rm_rf(tmp_root) if File.exist?(tmp_root)
-
-def mock_gemset(ruby_name, gemset_name=nil)
-  if gemset_name.nil?
-    FileUtils.mkdir_p(File.join(ENV['rvm_gems_path'], "#{ruby_name}"))
-  else
-    FileUtils.mkdir_p(File.join(ENV['rvm_gems_path'], "#{ruby_name}#{ENV['rvm_gemset_separator']}#{gemset_name}"))
-  end
-end
-
-FileUtils.mkdir_p(File.join(ENV['rvm_rubies_path'], 'default'))
-
-["macruby-0.6", "rbx-1.0.1-20100603", "ree-1.8.7-2010.02", "ruby-1.8.7-p174", 
-  "ruby-1.8.7-p299", "ruby-1.9.1-p378", "ruby-1.9.2-rc2"].each do |ruby_name|
-    FileUtils.mkdir_p(File.join(ENV['rvm_rubies_path'], ruby_name))
-    mock_gemset(ruby_name)
-    mock_gemset(ruby_name, 'global')
-end
-
-class RVMCompletion
-  # Required for mocking gemsets based upon selected ruby
-  attr_writer :current_ruby_path
-end
+require 'rvm_mock_environment'
 
 class Test::Unit::TestCase
+  # Fake the path to a ruby install used in rvm. This is required since
+  # normally, the completion resorts to the shell command 'which ruby' to
+  # determine this, which obviously is not reproducible in unit tests across
+  # environmente. Will create all mocked gemsets specified in options[:gemsets] array
   def self.using_ruby(ruby_name, options={})
     options = {:gemsets => []}.merge(options)
     options[:gemsets].each do |gemset|
@@ -54,6 +26,9 @@ class Test::Unit::TestCase
     end
   end
   
+  # Processes the completion for the given comp line(s) and yields the 
+  # shoulda context. If used after using_ruby will use that ruby with a mocked
+  # bin path
   def self.completion_for(*comp_lines)
     comp_lines.each do |comp_line|
       context "Completion for '#{comp_line}'" do
@@ -77,6 +52,7 @@ class Test::Unit::TestCase
     end
   end
   
+  # Asserts the completion stored in subject includes the given values (and only those)
   def self.should_include(*values)
     should "return #{values.length} completions" do
       assert_equal values.length, subject.length
@@ -89,9 +65,45 @@ class Test::Unit::TestCase
     end
   end
   
+  # Asserts that no completions are returned in subject
   def self.should_include_nothing
     should "include nothing in completion" do
       assert_equal 0, subject.length
     end
   end
+  
+  def self.with_rvm_scripts_path(path)
+    context "with rvm scripts path set to #{path}" do
+      setup { ENV['rvm_scripts_path'] = path }
+      yield
+    end
+  end
+  
+  def self.running_install_script
+    context "running the install script" do
+      setup do
+        @output = `#{File.join(File.dirname(__FILE__), '../bin/install-rvm-completion')}`
+      end
+      subject { @output }
+      yield
+    end
+  end
+  
+  def self.should_print(message)
+    should "print '#{message}'" do
+      assert_match(/#{message}/, subject)
+    end
+  end
+  
+  def self.should_not_have_copied_the_script
+    should "not have copied the completion script" do
+      assert !File.exist?(File.join(ENV['rvm_scripts_path'], 'rvm-completion.rb'))
+    end
+  end
+  
+  def self.should_have_copied_the_script
+    should "have copied the completion script" do
+      assert File.exist?(File.join(ENV['rvm_scripts_path'], 'rvm-completion.rb'))
+    end
+  end
 end

data/test/rvm_mock_environment.rb

@@ -0,0 +1,34 @@
+# Set up a faked rvm environment for tests
+
+# Define path to tmp directory
+tmp_root = File.expand_path(File.join(File.dirname(__FILE__), '../tmp'))
+
+# Set environment vars used in completion to test-specific ones
+ENV['rvm_rubies_path'] = File.join(tmp_root, 'rubies')
+ENV['rvm_gems_path'] = File.join(tmp_root, 'gems')
+ENV['rvm_gemset_separator'] = '@'
+
+# Clean up and prepare test folders
+FileUtils.rm_rf(tmp_root) if File.exist?(tmp_root)
+
+def mock_gemset(ruby_name, gemset_name=nil)
+  if gemset_name.nil?
+    FileUtils.mkdir_p(File.join(ENV['rvm_gems_path'], "#{ruby_name}"))
+  else
+    FileUtils.mkdir_p(File.join(ENV['rvm_gems_path'], "#{ruby_name}#{ENV['rvm_gemset_separator']}#{gemset_name}"))
+  end
+end
+
+FileUtils.mkdir_p(File.join(ENV['rvm_rubies_path'], 'default'))
+
+["macruby-0.6", "rbx-1.0.1-20100603", "ree-1.8.7-2010.02", "ruby-1.8.7-p174", 
+  "ruby-1.8.7-p299", "ruby-1.9.1-p378", "ruby-1.9.2-rc2"].each do |ruby_name|
+    FileUtils.mkdir_p(File.join(ENV['rvm_rubies_path'], ruby_name))
+    mock_gemset(ruby_name)
+    mock_gemset(ruby_name, 'global')
+end
+
+class RVMCompletion
+  # Required for mocking gemsets based upon selected ruby
+  attr_writer :current_ruby_path
+end

data/test/test_installer.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class TestInstaller < Test::Unit::TestCase
+  with_rvm_scripts_path '' do
+    running_install_script do
+      should_print 'Failed to find rvm scripts path - is rvm installed correctly?'
+      should_not_have_copied_the_script
+    end
+  end
+  
+  with_rvm_scripts_path File.expand_path(File.join(File.dirname(__FILE__), '../tmp')) do
+    running_install_script do
+      should_print "Success! rvm completion"
+      should_print "If you didn't do so before, please add the following line at the end of your"
+      should_have_copied_the_script
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rvm-completion
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -52,6 +52,8 @@ files:
 - lib/rvm-completion.rb
 - rvm-completion.gemspec
 - test/helper.rb
+- test/rvm_mock_environment.rb
+- test/test_installer.rb
 - test/test_rvm-completion.rb
 has_rdoc: true
 homepage: http://github.com/colszowka/rvm-completion
@@ -59,7 +61,7 @@ licenses: []
 
 post_install_message: |+
   
-  To install rvm completion v0.2.0, please run 'install-rvm-completion' in your terminal now!
+  To install rvm completion v0.2.1, please run 'install-rvm-completion' in your terminal now!
   
 rdoc_options: 
 - --charset=UTF-8
@@ -92,4 +94,6 @@ specification_version: 3
 summary: bash completion for Ruby Version Manager
 test_files: 
 - test/helper.rb
+- test/rvm_mock_environment.rb
+- test/test_installer.rb
 - test/test_rvm-completion.rb