gem-wrappers 0.0.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 709fca399c2f68279a1d89522359d1a6e5ed01df
-  data.tar.gz: ee8fc199eb0a588fc3e04d880e189ec806b38dca
+  metadata.gz: 761e2571ef7fc92b5714b61cfcf5ac00c5a18b05
+  data.tar.gz: 981ecd6d3091a20ecd5ce0b50629ccd099c568e0
 SHA512:
-  metadata.gz: fff8aad877f03341680d6e8972e50cad735648b2ba7187a21231515e4d41945ef2ac8410154f51fe5305d8f26f556bdc7d267c93e8df9fa975779932715fc427
-  data.tar.gz: a5935e69c7501a16057f9bc160f1d671bc19a72d6202110b715df2377159d491cbba0fc60b3ac0d1993d7d28af2cfd29c7cc76ab02ae68947749a56f086bfc48
+  metadata.gz: 382b5be8ff702859ba69a9ee2da720c31f987ef35bcdd553a686231c7ff14749a34479d1faff251fb1f307c97152bc43c5a306ac3cab9e438a9b0efcdda97164
+  data.tar.gz: 36806d2e568a7f1423914e7eaed9bff66562020cf4b12b341c959aba8f731de799f55648c0184133698e0bee7576ae4936f01a36b2f3721f49e45a3ca0eea277

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+#ruby=2.0.0
+
+gemspec

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("demo", "test")
+  t.pattern = "test/**/*_test.rb"
+end

data/gem-wrappers.gemspec

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # -*- encoding: utf-8 -*-
 
-require File.expand_path("../lib/gem/wrappers/version.rb", __FILE__)
+require File.expand_path("../lib/gem-wrappers/version.rb", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "gem-wrappers"
-  s.version = Gem::Wrappers::VERSION
+  s.version = GemWrappers::VERSION
   s.authors = ["Michal Papis"]
   s.email = ["mpapis@gmail.com"]
   s.homepage = "https://github.com/rvm/gem-wrappers"

data/lib/gem-wrappers.rb

@@ -0,0 +1,27 @@
+require 'gem-wrappers/environment'
+require 'gem-wrappers/installer'
+
+module GemWrappers
+
+  def self.install(executables)
+    environment = GemWrappers::Environment.new
+    environment.ensure
+    wrappers = GemWrappers::Installer.new(environment.file)
+    wrappers.ensure
+    executables.each do |executable|
+      wrappers.install(executable)
+    end
+    %w{ruby gem}.each do |executable|
+      wrappers.install(executable)
+    end
+  end
+
+  def self.wrappers_path
+    GemWrappers::Installer.wrappers_path
+  end
+
+  def self.environment_file
+    GemWrappers::Environment.file
+  end
+
+end

data/lib/gem-wrappers/command.rb

@@ -0,0 +1,69 @@
+require 'rubygems/command_manager'
+require 'rubygems/installer'
+require 'rubygems/version'
+require 'gem-wrappers'
+
+class WrappersCommand < Gem::Command
+  def initialize
+    super 'regenerate_binstubs', 'Re run generation of environment wrappers for gems.'
+  end
+
+  def arguments # :nodoc:
+    "regenerate        regenerate environment wrappers for current Gem.home"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [regenerate]"
+  end
+
+  def defaults_str # :nodoc:
+    ""
+  end
+
+  def description # :nodoc:
+    <<-DOC
+Show (default) or regenerate environment wrappers for current 'GEM_HOME'.
+DOC
+  end
+
+  def execute
+    subcommand = get_one_optional_argument || ''
+    case subcommand
+    when ''
+      execute_show
+    when 'regenerate'
+      execute_regenerate
+    else
+      execute_unknown subcommand
+    end
+  end
+
+  def execute_show
+    $stdout.puts description
+    $stdout.puts "   Wrappers path: #{GemWrappers.wrappers_path}"
+    $stdout.puts "Environment file: #{GemWrappers.environment_file}"
+  end
+
+  def execute_unknown(subcommand)
+    $stderr.puts "Unknown wrapper subcommand: #{subcommand}"
+    $stdout.puts description
+    false
+  end
+
+  def execute_regenerate
+    gem_dir_specs = installed_gems.select { |spec|
+      File.exists?( File.join( Gem.dir, 'gems', spec.full_name ) )
+    }
+    executables = gem_dir_specs.map(&:executables).reject(&:nil?).inject(&:+).reject(&:nil?)
+    GemWrappers.install(executables)
+  end
+
+  private
+  def installed_gems
+    if Gem::VERSION > '1.8' then
+      Gem::Specification.to_a
+    else
+      Gem.source_index.map{|name,spec| spec}
+    end
+  end
+end

data/lib/gem-wrappers/environment.rb

@@ -0,0 +1,55 @@
+require 'erb'
+
+module GemWrappers
+  class Environment
+
+    def self.file
+      path = Gem.configuration && Gem.configuration[:wrappers_environment_file]
+      if path.nil? || path == ""
+        path = File.join(Gem.dir, 'environment')
+      end
+      path
+    end
+
+    def file
+      @file ||= self.class.file
+    end
+
+    def path_take
+      return @path_take if @path_take
+      @path_take = Gem.configuration && Gem.configuration[:wrappers_path_take] || 1
+      @path_take += gem_path.size
+    end
+
+    def ensure
+      return if File.exist?(file)
+      FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(File.dirname(file))
+      content = ERB.new(template).result(binding)
+      File.open(file, 'w') do |file|
+        file.write(content)
+      end
+      File.chmod(0644, file)
+    end
+
+    def template
+      @template ||= <<-TEMPLATE
+export PATH="<%= path.join(":") %>:$PATH"
+export GEM_PATH="<%= gem_path.join(":") %>"
+export GEM_HOME="<%= gem_home %>"
+TEMPLATE
+    end
+
+    def gem_path
+      @gem_path ||= Gem.path
+    end
+
+    def gem_home
+      @gem_home ||= Gem.dir
+    end
+
+    def path(base = ENV['PATH'])
+      @path ||= base.split(":").take(path_take)
+    end
+
+  end
+end

data/lib/gem-wrappers/installer.rb

@@ -0,0 +1,52 @@
+require 'erb'
+
+module GemWrappers
+  class Installer
+    attr_reader :environment_file
+
+    def initialize(environment_file)
+      @environment_file = environment_file
+    end
+
+    def self.wrappers_path
+      Gem.configuration && Gem.configuration[:wrappers_path] ||
+      File.join(Gem.dir, 'wrappers')
+    end
+
+    def wrappers_path
+      @wrappers_path ||= self.class.wrappers_path
+    end
+
+    def ensure
+      FileUtils.mkdir_p(wrappers_path) unless File.exist?(wrappers_path)
+      # exception based on Gem::Installer.generate_bin
+      raise Gem::FilePermissionError.new(wrappers_path) unless File.writable?(wrappers_path)
+    end
+
+    def install(executable)
+      content = ERB.new(template).result(binding)
+      file = File.join(wrappers_path, executable)
+      File.open(file, 'w') do |file|
+        file.write(content)
+      end
+      File.chmod(0755, file)
+    end
+
+    def template
+      @template ||= <<-TEMPLATE
+#!/usr/bin/env bash
+
+if
+  [[ -s "<%= environment_file %>" ]]
+then
+  source "<%= environment_file %>"
+  exec <%= executable %> "$@"
+else
+  echo "ERROR: Missing RVM environment file: '<%= environment_file %>'" >&2
+  exit 1
+fi
+TEMPLATE
+    end
+
+  end
+end

data/lib/gem-wrappers/specification.rb

@@ -0,0 +1,17 @@
+module GemWrappers
+  module Specification
+    def self.find
+      @gem_wrappers_spec ||=
+        if Gem::Specification.respond_to?(:find_by_name)
+          Gem::Specification.find_by_name("gem-wrappers")
+        else
+          Gem.source_index.find_name("gem-wrappers").last
+        end
+    rescue Gem::LoadError
+      nil
+    end
+    def self.version
+      find ? find.version.to_s : nil
+    end
+  end
+end

data/lib/gem-wrappers/version.rb

@@ -0,0 +1,3 @@
+module GemWrappers
+  VERSION = "0.7.0"
+end

data/lib/gem/wrappers/specification.rb

@@ -0,0 +1,19 @@
+module Gem
+  module Wrappers
+    module Specification
+      def self.find
+        @executable_hooks_spec ||=
+          if Gem::Specification.respond_to?(:find_by_name)
+            Gem::Specification.find_by_name("gem-wrappers")
+          else
+            Gem.source_index.find_name("gem-wrappers").last
+          end
+      rescue Gem::LoadError
+        nil
+      end
+      def self.version
+        find ? find.version.to_s : nil
+      end
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,18 @@
+# Simulate require_relative - it's required as the plugin can be called in wrong version or from bundler.
+require File.expand_path('../gem-wrappers/specification.rb', __FILE__)
+
+called_path, called_version = __FILE__.match(/^(.*\/gem-wrappers-([^\/]+)\/lib).*$/)[1..2]
+
+# continue only if loaded and called versions all the same, and not shared gems disabled in bundler
+if
+  ( $:.include?(called_path) || GemWrappers::Specification.version == called_version ) and
+  ( !defined?(Bundler) || ( defined?(Bundler) && Bundler::SharedHelpers.in_bundle? && !Bundler.settings[:disable_shared_gems]) )
+
+  require 'gem-wrappers'
+  require 'gem-wrappers/command'
+
+  Gem.post_install do |installer|
+    GemWrappers.install(installer.spec.executables)
+  end
+  Gem::CommandManager.instance.register_command :wrappers
+end

data/test/gem-wrappers/command_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'tempfile'
+require 'gem-wrappers/environment'
+
+describe WrappersCommand do
+  subject do
+    WrappersCommand.new
+  end
+
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+
+  it "has some strings" do
+    subject.arguments.class.must_equal(String)
+    subject.usage.class.must_equal(String)
+    subject.defaults_str.class.must_equal(String)
+    subject.description.class.must_equal(String)
+    subject.program_name.class.must_equal(String)
+  end
+
+  it "shows help on unknown command" do
+    subject.options[:args] = ['wrong']
+    subject.execute
+  end
+
+end

data/test/gem-wrappers/environment_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'tempfile'
+require 'gem-wrappers/environment'
+
+describe GemWrappers::Environment do
+  describe "configuration" do
+    it "uses default file" do
+      Gem.configuration[:wrappers_environment_file] = nil
+      GemWrappers::Environment.file.must_equal(File.join(Gem.dir, "environment"))
+      GemWrappers::Environment.new.file.must_equal(GemWrappers::Environment.file)
+    end
+    it "reads configured file" do
+      Gem.configuration[:wrappers_environment_file] = "/path/to/environment"
+      GemWrappers::Environment.file.must_equal("/path/to/environment")
+      GemWrappers::Environment.new.file.must_equal("/path/to/environment")
+      Gem.configuration[:wrappers_environment_file] = nil
+    end
+    it "uses default take" do
+      Gem.configuration[:wrappers_path_take] = nil
+      GemWrappers::Environment.new.path_take.must_equal(Gem.path.size + 1)
+    end
+    it "reads configured take" do
+      Gem.configuration[:wrappers_path_take] = 0
+      GemWrappers::Environment.new.path_take.must_equal(Gem.path.size)
+      Gem.configuration[:wrappers_path_take] = nil
+    end
+  end
+
+  describe "instance" do
+    subject do
+      GemWrappers::Environment.new
+    end
+
+    before do
+      @test_file = Tempfile.new('environment-file')
+    end
+
+    after do
+      @test_file.close
+      @test_file.unlink
+    end
+
+    it "calculates path part 1" do
+      subject.instance_variable_set(:@path_take, 1)
+      subject.path("/one/bin:/two/bin:/three/bin:/four/bin").must_equal(["/one/bin"])
+    end
+
+    it "calculates path part 3" do
+      subject.instance_variable_set(:@path_take, 3)
+      subject.path("/one/bin:/two/bin:/three/bin:/four/bin").must_equal(["/one/bin", "/two/bin", "/three/bin"])
+    end
+
+    it "does not overwrite existing file" do
+      subject.instance_variable_set(:@file, @test_file.path)
+      File.open(subject.file, "w") do |file|
+        file.write("something")
+      end
+      subject.ensure
+      File.open(subject.file, "r") do |file|
+        file.read.must_equal("something")
+      end
+    end
+
+    it "creates environment file" do
+      subject.instance_variable_set(:@path, ["/one/bin", "/two/bin"])
+      subject.instance_variable_set(:@gem_path, ["/one", "/two"])
+      subject.instance_variable_set(:@gem_home, "/one")
+      subject.instance_variable_set(:@file, @test_file.path)
+      @test_file.close
+      @test_file.unlink
+      subject.ensure
+      File.open(subject.file, "r") do |file|
+        file.read.must_equal(<<-EXPECTED)
+export PATH="/one/bin:/two/bin:$PATH"
+export GEM_PATH="/one:/two"
+export GEM_HOME="/one"
+EXPECTED
+      end
+    end
+
+  end
+end

data/test/gem-wrappers/installer_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'tempfile'
+require 'gem-wrappers/installer'
+
+describe GemWrappers::Installer do
+  describe "configuration" do
+    it "uses default file" do
+      Gem.configuration[:wrappers_path] = nil
+      GemWrappers::Installer.wrappers_path.must_equal(File.join(Gem.dir, 'wrappers'))
+      GemWrappers::Installer.new(nil).wrappers_path.must_equal(GemWrappers::Installer.wrappers_path)
+    end
+    it "reads configured file" do
+      Gem.configuration[:wrappers_path] = "/path/to/wrappers"
+      GemWrappers::Installer.wrappers_path.must_equal("/path/to/wrappers")
+      GemWrappers::Installer.new(nil).wrappers_path.must_equal("/path/to/wrappers")
+      Gem.configuration[:wrappers_path] = nil
+    end
+  end
+
+  describe "instance" do
+    subject do
+      GemWrappers::Installer.new('/path/to/environment')
+    end
+
+    before do
+      file = Tempfile.new('wrappers')
+      @test_path = file.path
+      file.close
+      file.unlink
+    end
+
+    after do
+      FileUtils.rm_rf(@test_path)
+    end
+
+    it "does create target dir" do
+      subject.instance_variable_set(:@wrappers_path, @test_path)
+      File.exist?(subject.wrappers_path).must_equal(false)
+      subject.ensure
+      File.exist?(subject.wrappers_path).must_equal(true)
+    end
+
+    it "creates wrapper" do
+      subject.instance_variable_set(:@wrappers_path, @test_path)
+      full_path = File.join(subject.wrappers_path, "rake")
+      File.exist?(full_path).must_equal(false)
+      subject.ensure
+      subject.install("rake")
+      File.open(full_path, "r") do |file|
+        file.read.must_equal(<<-EXPECTED)
+#!/usr/bin/env bash
+
+if
+  [[ -s "/path/to/environment" ]]
+then
+  source "/path/to/environment"
+  exec rake "$@"
+else
+  echo "ERROR: Missing RVM environment file: '/path/to/environment'" >&2
+  exit 1
+fi
+EXPECTED
+      end
+    end
+
+  end
+end

data/test/gem-wrappers/specification_and_version_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'gem-wrappers/specification'
+require 'gem-wrappers/version'
+
+describe GemWrappers::Specification do
+
+  it "finds specification" do
+    GemWrappers::Specification.find.name.must_equal("gem-wrappers")
+  end
+
+  it "gets specification version" do
+    GemWrappers::Specification.version.must_equal(GemWrappers::VERSION)
+  end
+
+end

data/test/gem-wrappers_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+require 'tempfile'
+require 'gem-wrappers'
+
+describe GemWrappers do
+  before do
+    file = Tempfile.new('gem_dir')
+    @test_path = file.path
+    file.close
+    file.unlink
+  end
+
+  after do
+    FileUtils.rm_rf(@test_path)
+  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
+  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)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require "coveralls"
+require "simplecov"
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter,
+  ]
+  command_name "Unit Tests"
+  add_filter "/test/"
+  add_filter "/demo/"
+end
+
+Coveralls.noisy = true unless ENV['CI']
+
+require 'minitest/autorun'
+require 'minitest/unit'

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: gem-wrappers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Michal Papis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2013-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -87,11 +87,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - gem-wrappers.gemspec
-- lib/gem/wrappers/version.rb
+- lib/gem-wrappers.rb
+- lib/gem-wrappers/command.rb
+- lib/gem-wrappers/environment.rb
+- lib/gem-wrappers/installer.rb
+- lib/gem-wrappers/specification.rb
+- lib/gem-wrappers/version.rb
+- lib/gem/wrappers/specification.rb
+- lib/rubygems_plugin.rb
+- test/gem-wrappers/command_test.rb
+- test/gem-wrappers/environment_test.rb
+- test/gem-wrappers/installer_test.rb
+- test/gem-wrappers/specification_and_version_test.rb
+- test/gem-wrappers_test.rb
+- test/test_helper.rb
 homepage: https://github.com/rvm/gem-wrappers
 licenses:
 - Apache 2.0
@@ -102,18 +117,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Create gem wrappers for easy use of gems in cron and other system locations.
-test_files: []
+test_files:
+- test/gem-wrappers/command_test.rb
+- test/gem-wrappers/environment_test.rb
+- test/gem-wrappers/installer_test.rb
+- test/gem-wrappers/specification_and_version_test.rb
+- test/gem-wrappers_test.rb
+- test/test_helper.rb

data/lib/gem/wrappers/version.rb

@@ -1,5 +0,0 @@
-module Gem
-  module Wrappers
-    VERSION = "0.0.1"
-  end
-end