gem-wrappers 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  metadata.gz: 48cdb11322144423631158e936df29e14bc82b8f84f21ac86f4e7d1ff4e8385670f11e8ef281a31ae2e23e67230a5209174277bf9bc5f8022896e848733c84a8
-  data.tar.gz: c345081a561bb037c618a9d589723e35bfa95442701024890a9269a6052a22afeaa7f7d4f97092af28194e82083ccd39b46adb4b6d00420e1d588026bf68c641
+  metadata.gz: 3ee86ce7a16e5713e54f5107c98e87a120c1b1538294ced359397a486fbebf440c3011f3a1824c22b17b4a01cedcd58a5a193ba85e5f9c388a6deec42b45a216
+  data.tar.gz: a2d79cfbf6daf92e5e458147fc6324e8b984804481c25b7a726eb64213db3186551df04caf2009eca954d7ef56b76c9bbe720ecdad8c099b14cf9c14b74937ac
 SHA1: 
-  metadata.gz: c63aa0209b7c2dab346841bfd12b7e5fa6e01804
-  data.tar.gz: 515304c21b58a3535e6dba06229f95af1f4cc0d9
+  metadata.gz: d269e03a5d350449af2a2d0ea56d5b389a753bac
+  data.tar.gz: c9c42d1cdecfafe73f3bc71e812982de79ec18a8

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+before_install:
+  - "if [[ $TRAVIS_RUBY_VERSION == 1.8.7 ]] ; then rvm rubygems latest-2.1 ; fi"
 rvm:
   - jruby
   - ruby-head

data/Changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.2
+date: 2013-12-31
+
+- improved tests
+- improved code to detect and set executable bits for the created wrapper, fix #3
+
 ## 1.2.1
 date: 2013-12-22
 

data/README.md

@@ -9,6 +9,14 @@
 
 Create gem wrappers for easy use of gems in cron and other system locations.
 
+## Installation
+
+This gem should be available in RVM `1.25+`, to install manually:
+
+```bash
+gem install gem-wrappers
+```
+
 ## Configuration / Defaults
 
 In `~/.gemrc` you can overwrite this defaults:
@@ -33,6 +41,27 @@ gem wrappers regenerate
 
 wrappers will be generated in `$GEM_HOME/wrappers/`.
 
+### Example
+
+Install popular http server `unicorn`:
+
+```bash
+gem install gem-wrappers # assuming it was not installed already
+gem install unicorn
+```
+
+The `unicorn` wrapper is located in `$GEM_HOME/wrappers`:
+
+```bash
+ls `gem env gemhome`/wrappers/unicorn
+```
+
+```ssh
+/home/mpapis/.rvm/gems/ruby-2.1.0-preview2/wrappers/unicorn
+```
+
+This script will make sure proper environment is available.
+
 ## Generating scripts wrappers
 
 It is possible to generate wrappers for custom scripts:

data/lib/gem-wrappers.rb

@@ -3,10 +3,16 @@ require 'gem-wrappers/installer'
 
 module GemWrappers
 
+  def self.environment
+    @environment ||= GemWrappers::Environment.new
+  end
+
+  def self.installer
+    @installer ||= GemWrappers::Installer.new(@environment.file_name)
+  end
+
   def self.install(executables)
-    environment = GemWrappers::Environment.new
     environment.ensure
-    installer = GemWrappers::Installer.new(environment.file_name)
     installer.ensure
 
     # gem executables
@@ -21,8 +27,6 @@ module GemWrappers
   end
 
   def self.uninstall(executables)
-    installer = GemWrappers::Installer.new
-
     # gem executables
     executables.each do |executable|
       installer.uninstall(executable)
@@ -30,11 +34,11 @@ module GemWrappers
   end
 
   def self.wrappers_path
-    GemWrappers::Installer.wrappers_path
+    installer.wrappers_path
   end
 
   def self.environment_file
-    GemWrappers::Environment.file_name
+    environment.file_name
   end
 
 end

data/lib/gem-wrappers/command.rb

@@ -35,7 +35,7 @@ DOC
     when 'regenerate'
       execute_regenerate
     when FileExist
-      execute_regenerate([File.expand_path(subcommand)]) # TODO: File.expand_path not tested!
+      execute_regenerate([File.expand_path(subcommand)])
     else
       execute_unknown subcommand
     end
@@ -43,8 +43,8 @@ DOC
 
   def execute_show
     $stdout.puts description
-    $stdout.puts "   Wrappers path: #{GemWrappers.wrappers_path}"
-    $stdout.puts "Environment file: #{GemWrappers.environment_file}"
+    $stdout.puts "   Wrappers path: #{gem_wrappers.wrappers_path}"
+    $stdout.puts "Environment file: #{gem_wrappers.environment_file}"
   end
 
   def execute_unknown(subcommand)
@@ -54,11 +54,15 @@ DOC
   end
 
   def execute_regenerate(list = executables)
-    GemWrappers.install(list)
+    gem_wrappers.install(list)
   end
 
 private
 
+  def gem_wrappers
+    @gem_wrappers ||= GemWrappers
+  end
+
   def executables
     # do not use map(&:...) - for ruby 1.8.6 compatibility
     @executables ||= GemWrappers::Specification.installed_gems.map{|gem| gem.executables }.inject{|sum, n| sum + n } || []

data/lib/gem-wrappers/installer.rb

@@ -36,7 +36,7 @@ module GemWrappers
       File.open(file_name, 'w') do |file|
         file.write(content)
       end
-      File.chmod(0755, file_name)
+      file_set_executable(file_name)
     end
 
     def executable_expanded
@@ -62,5 +62,11 @@ fi
 TEMPLATE
     end
 
+  private
+    def file_set_executable(file_name)
+      stat = File.stat(file_name)
+      File.chmod(stat.mode|0111, file_name) unless stat.mode&0111 == 0111
+    end
+
   end
 end

data/lib/gem-wrappers/version.rb

@@ -1,3 +1,3 @@
 module GemWrappers
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/test/gem-wrappers/command_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 require 'tempfile'
 require 'gem-wrappers/command'
+require 'gem-wrappers/fakes'
 
 describe WrappersCommand do
   subject do
@@ -8,6 +9,8 @@ describe WrappersCommand do
   end
 
   before do
+    @fake_installer = GemWrappers::Fake.new
+    subject.instance_variable_set(:@gem_wrappers, @fake_installer)
     $stdout = StringIO.new
     $stderr = StringIO.new
   end
@@ -33,15 +36,9 @@ describe WrappersCommand do
   end
 
   it "does show" do
-    Gem.configuration[:wrappers_environment_file] = "/path/to/environment"
-    Gem.configuration[:wrappers_path] = "/path/to/wrappers"
-
     subject.options[:args] = []
     subject.execute
 
-    Gem.configuration[:wrappers_environment_file] = nil
-    Gem.configuration[:wrappers_path] = nil
-
     $stderr.string.must_equal("")
     $stdout.string.must_equal(<<-EXPECTED)
 #{subject.description.strip}
@@ -50,60 +47,35 @@ Environment file: /path/to/environment
 EXPECTED
   end
 
+  it "regenerates wrappers" do
+    subject.instance_variable_set(:@executables, %w{rake})
+    subject.options[:args] = ['regenerate']
+    subject.execute
+    @fake_installer.executables.must_equal(%w{rake})
+  end
 
-  describe "wrappers" do
+  describe "script wrappers" do
     before do
-      file = Tempfile.new('command-wrappers')
-      @test_path = file.path
-      file.close
-      file.unlink
+      @file = Tempfile.new('command-wrappers')
     end
 
     after do
-      FileUtils.rm_rf(@test_path)
+      @file.close
+      @file.unlink
     end
 
-    it "regenerates wrappers" do
-      Gem.configuration[:wrappers_environment_file] = File.join(@test_path, "environment")
-      Gem.configuration[:wrappers_path] =             File.join(@test_path, "wrappers")
-
-      subject.instance_variable_set(:@executables, %w{rake})
-      subject.options[:args] = ['regenerate']
+    it "generates script wrapper full path" do
+      subject.options[:args] = [@file.path]
       subject.execute
-
-      Gem.configuration[:wrappers_environment_file] = nil
-      Gem.configuration[:wrappers_path] = nil
-
-      File.exist?(File.join(@test_path, "environment")).must_equal(true)
-      File.exist?(File.join(@test_path, "wrappers", "gem")).must_equal(true)
-      File.exist?(File.join(@test_path, "wrappers", "rake")).must_equal(true)
-      File.exist?(File.join(@test_path, "wrappers", "ruby")).must_equal(true)
-      File.exist?(File.join(@test_path, "wrappers", "test")).must_equal(false)
-
-      $stderr.string.must_equal("")
-      $stdout.string.must_equal("")
+      @fake_installer.executables.must_equal([@file.path])
     end
 
-    it "generates script wrapper" do
-      FileUtils.mkdir_p(@test_path)
-      test_file = File.join(@test_path, "test_file.sh")
-      File.open(test_file, "w") do |file|
-        file.puts "echo test"
+    it "generates script wrapper relative" do
+      Dir.chdir(File.dirname(@file.path)) do
+        subject.options[:args] = [File.basename(@file.path)]
+        subject.execute
+        @fake_installer.executables.must_equal([@file.path])
       end
-      Gem.configuration[:wrappers_environment_file] = File.join(@test_path, "environment")
-      Gem.configuration[:wrappers_path] =             File.join(@test_path, "wrappers")
-
-      subject.options[:args] = [test_file]
-      subject.execute
-
-      Gem.configuration[:wrappers_environment_file] = nil
-      Gem.configuration[:wrappers_path] = nil
-
-      File.exist?(File.join(@test_path, "environment")).must_equal(true)
-      File.exist?(File.join(@test_path, "wrappers", "test_file.sh")).must_equal(true)
-
-      $stderr.string.must_equal("")
-      $stdout.string.must_equal("")
     end
   end
 

data/test/gem-wrappers/fakes.rb

@@ -0,0 +1,56 @@
+module GemWrappers
+  class FakeInstaller
+    def initialize
+      @executables = []
+    end
+    def install(executable)
+      @executables << executable
+    end
+    def uninstall(executable)
+      @executables.delete(executable)
+    end
+    def executables
+      @executables
+    end
+    def ensure
+      @ensure = true
+    end
+    def ensure?
+      @ensure
+    end
+    def wrappers_path
+      "/path/to/wrappers"
+    end
+  end
+  class FakeEnvironment
+    def ensure
+      @ensure = true
+    end
+    def ensure?
+      @ensure
+    end
+    def file_name
+      "/path/to/environment"
+    end
+  end
+  class Fake
+    def initialize
+      @executables = []
+    end
+    def install(executables)
+      @executables += executables
+    end
+    def uninstall(executables)
+      @executables -= executables
+    end
+    def executables
+      @executables
+    end
+    def environment_file
+      "/path/to/environment"
+    end
+    def wrappers_path
+      "/path/to/wrappers"
+    end
+  end
+end

data/test/gem-wrappers/installer_test.rb

@@ -127,6 +127,7 @@ else
 fi
 EXPECTED
       end
+      File.executable?(full_path).must_equal(true)
     end
 
     it "removes wrapper" do

data/test/gem-wrappers_test.rb

@@ -1,53 +1,40 @@
 require 'test_helper'
 require 'tempfile'
 require 'gem-wrappers'
+require 'gem-wrappers/fakes'
 
 describe GemWrappers do
+  subject do
+    GemWrappers
+  end
+
   before do
-    file = Tempfile.new('gem_dir')
-    @test_path = file.path
-    file.close
-    file.unlink
+    @fake_installer    = GemWrappers::FakeInstaller.new
+    @fake_envvironment = GemWrappers::FakeEnvironment.new
+    subject.instance_variable_set(:@installer,   @fake_installer)
+    subject.instance_variable_set(:@environment, @fake_envvironment)
   end
 
-  after do
-    FileUtils.rm_rf(@test_path)
+  it "reads configured file" do
+    subject.environment_file.must_equal("/path/to/environment")
   end
 
-  describe "configuration" do
-    it "reads configured file" do
-      Gem.configuration[:wrappers_environment_file] = "/path/to/environment"
-      GemWrappers.environment_file.must_equal("/path/to/environment")
-      Gem.configuration[:wrappers_environment_file] = nil
-    end
-    it "reads configured file" do
-      Gem.configuration[:wrappers_path] = "/path/to/wrappers"
-      GemWrappers.wrappers_path.must_equal("/path/to/wrappers")
-      Gem.configuration[:wrappers_path] = nil
-    end
+  it "reads configured file" do
+    subject.wrappers_path.must_equal("/path/to/wrappers")
   end
 
   it "does create environment and wrapper" do
-    Gem.configuration[:wrappers_path] = File.join(@test_path, "wrappers")
-    Gem.configuration[:wrappers_environment_file] = File.join(@test_path, "environment")
-    Gem.configuration[:wrappers_path_take] = 0
-    GemWrappers.install(%w{rake test})
-    File.exist?(File.join(@test_path, "environment")).must_equal(true)
-    File.exist?(File.join(@test_path, "wrappers", "gem")).must_equal(true)
-    File.exist?(File.join(@test_path, "wrappers", "rake")).must_equal(true)
-    File.exist?(File.join(@test_path, "wrappers", "ruby")).must_equal(true)
-    File.exist?(File.join(@test_path, "wrappers", "test")).must_equal(true)
-    File.exist?(File.join(@test_path, "wrappers", "other")).must_equal(false)
+    subject.install(%w{rake test})
+    @fake_envvironment.ensure?.must_equal(true)
+    @fake_installer.ensure?.must_equal(true)
+    @fake_installer.executables.must_equal(%w{rake test ruby gem erb irb ri rdoc testrb})
   end
 
   it "does remove wrapper" do
-    Gem.configuration[:wrappers_path] = File.join(@test_path, "wrappers")
-    Gem.configuration[:wrappers_environment_file] = File.join(@test_path, "environment")
-    Gem.configuration[:wrappers_path_take] = 0
-    GemWrappers.install(%w{rake})
-    File.exist?(File.join(@test_path, "wrappers", "rake")).must_equal(true)
-    GemWrappers.uninstall(%w{rake})
-    File.exist?(File.join(@test_path, "wrappers", "rake")).must_equal(false)
+    subject.install(%w{rake})
+    @fake_installer.executables.must_equal(%w{rake ruby gem erb irb ri rdoc testrb})
+    subject.uninstall(%w{rake})
+    @fake_installer.executables.must_equal(%w{ruby gem erb irb ri rdoc testrb})
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gem-wrappers
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Michal Papis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-12-22 00:00:00 Z
+date: 2013-12-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -59,6 +59,7 @@ files:
 - lib/rubygems_plugin.rb
 - test/gem-wrappers/command_test.rb
 - test/gem-wrappers/environment_test.rb
+- test/gem-wrappers/fakes.rb
 - test/gem-wrappers/installer_test.rb
 - test/gem-wrappers/specification_and_version_test.rb
 - test/gem-wrappers_test.rb
@@ -89,6 +90,7 @@ summary: Create gem wrappers for easy use of gems in cron and other system locat
 test_files: 
 - test/gem-wrappers/command_test.rb
 - test/gem-wrappers/environment_test.rb
+- test/gem-wrappers/fakes.rb
 - test/gem-wrappers/installer_test.rb
 - test/gem-wrappers/specification_and_version_test.rb
 - test/gem-wrappers_test.rb