nlmt-wrappers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2735d2d31d0774536be96d8442b7aa9993f53d0908c7872acffee12effac461
+  data.tar.gz: 8296b86db3875290249fc119bdbd374de91f7aa613019351714b6b003169bcd4
+SHA512:
+  metadata.gz: efb5b654d8bbf4040527c603660baba60723692181c404ef57049e15e948a81f97c99663da8c1abf728ae261c98c3efa96fbf2b2aef99449e3f8486bb0ccf54c
+  data.tar.gz: d05a8fa10dc5779efe268ff862c32c6631fd0c302f74c296d1cf2f522db2d6d08559b65447181c2633eaed9dcc258e3111ae6050a913a213fdfce896a78cf618

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+coverage/
+*.gem
+/.bundle/

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+before_install:
+  - "if [[ $TRAVIS_RUBY_VERSION == 1.8.7 ]] ; then rvm rubygems latest-2.1 ; fi"
+  - "if [[ $TRAVIS_RUBY_VERSION == 1.9.3 ]] ; then gem update bundler ; fi"
+rvm:
+  - jruby
+  - ruby-head
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4.1
+  - rbx
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#rvm-test"
+  email:
+    recipients:
+      - ilmirashaikhraznova@gmail.com
+    on_failure: change
+matrix:
+  allow_failures:
+    - rvm: rbx
+  fast_finish: true

data/Changelog.md

@@ -0,0 +1,81 @@
+# Changelog
+
+## 1.4.0
+date: 2017-09-22
+
+- add option to show full path to single file
+- list actual list of generated wrappers in show
+
+## 1.3.2
+date: 2017-09-10
+
+- Avoid nested chdir warnings #11
+
+## 1.3.1
+date: 2017-08-24
+
+- detect ruby executables instead of using hardcoded list
+
+## 1.3.0
+date: 2017-07-08
+
+- add check if target files actually exist and are executable, fix #9
+- silence ivar warning in rubygems test suite, fix #7
+
+## 1.2.7
+date: 2014-10-10
+
+- improved command handling
+
+## 1.2.6.1
+date: 2014-10-10
+
+- improved output of listing executables
+
+## 1.2.6
+date: 2014-10-10
+
+- show list of executables
+- show info when `$GEM_WRAPPERS_DEBUG` is set
+
+## 1.2.5
+date: 2014-05-27
+
+- allow generating formatted binary wrappers, fix #5
+
+## 1.2.4
+date: 2014-01-03
+
+- require fileutils - needed on older rubies
+
+## 1.2.3
+date: 2013-12-31
+
+- fix uninstalling gems and add tests for it
+
+## 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
+
+- Add `ri`, `rdoc` and `testrb` to the list of default ruby executables
+
+## 1.2.0
+date: 2013-12-22
+
+- Add support for generating scripts wrappers
+- Improved gems searching and tests
+
+## 1.1.0
+date: 2013-12-20
+
+- Add functionality to uninstall wrappers when gem is uninstalled
+
+## 1.0.0
+date: 2013-12-19
+
+- Stable version released

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+#ruby=1.8.7
+
+gemspec
+
+group :development do
+  # statistics only on MRI 2.0 - avoid problems on older rubies
+  gem "redcarpet", :platforms => [:mri_20]
+  gem "simplecov", :platforms => [:mri_20]
+  gem "coveralls", :platforms => [:mri_20]
+
+  # rubinius support
+  gem "rubysl-mutex_m",   :platforms => [:rbx]
+  gem "rubysl-singleton", :platforms => [:rbx]
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2013-2014,2017 Michal Papis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+# Gem wrappers
+
+[![Gem Version](https://badge.fury.io/rb/nlmt-wrappers.png)](http://rubygems.org/gems/nlmt-wrappers)
+[![Code Climate](https://codeclimate.com/github/rvm/nlmt-wrappers.png)](https://codeclimate.com/github/rvm/nlmt-wrappers)
+[![Coverage Status](https://coveralls.io/repos/rvm/nlmt-wrappers/badge.png?branch=master)](https://coveralls.io/r/rvm/nlmt-wrappers?branch=master)
+[![Build Status](https://travis-ci.org/rvm/nlmt-wrappers.png?branch=master)](https://travis-ci.org/rvm/nlmt-wrappers)
+[![Dependency Status](https://gemnasium.com/rvm/nlmt-wrappers.png)](https://gemnasium.com/rvm/nlmt-wrappers)
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/gems/nlmt-wrappers/frames)
+
+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 nlmt-wrappers
+```
+
+## Configuration / Defaults
+
+In `~/.gemrc` you can overwrite this defaults:
+
+```ruby
+wrappers_path: GEM_HOME/wrappers
+wrappers_environment_file: GEM_HOME/environment
+wrappers_path_take: 1
+```
+
+It is not yet possible to put variables in the configuration,
+only relative and full paths will work, open a ticket if you need variables.
+
+## Generating wrappers
+
+By default wrappers are installed when a gem is installed,
+to rerun the process for all gems in `GEM_HOME` use:
+
+```bash
+gem wrappers regenerate
+```
+
+wrappers will be generated in `$GEM_HOME/wrappers/`.
+
+### Example
+
+Install popular http server `unicorn`:
+
+```bash
+gem install nlmt-wrappers # assuming it was not installed already
+gem install unicorn
+```
+
+The `unicorn` wrapper is located in `$GEM_HOME/wrappers`:
+
+```bash
+gem wrappers show 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:
+
+```bash
+gem wrappers /path/to/script
+```
+
+a wrapper `$GEM_HOME/wrappers/script` will be generated.
+
+## Showing current configuration
+
+To see paths that are used by gem run:
+
+```bash
+gem wrappers
+```
+
+## Environment file
+
+User can provide his own `environment` file,
+in case it is not available during generating wrappers it will be created using this template:
+
+```erb
+export PATH="<%= path.join(":") %>:$PATH"
+export GEM_PATH="<%= gem_path.join(":") %>"
+export GEM_HOME="<%= gem_home %>"
+```
+
+The `path` elements are calculated using this algorithm:
+
+```ruby
+ENV['PATH'].split(":").take(Gem.path.size + path_take)
+```

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/ext/wrapper_generator/Makefile

@@ -0,0 +1,4 @@
+all:
+
+install:
+

data/ext/wrapper_generator/extconf.rb

@@ -0,0 +1,27 @@
+# Fake building extension
+File.open('Makefile', 'w') { |f| f.write("all:\n\ninstall:\n\n") }
+File.open('make', 'w') do |f|
+  f.write('#!/bin/sh')
+  f.chmod(f.stat.mode | 0111)
+end
+File.open('wrapper_generator.so', 'w') {}
+File.open('wrapper_generator.dll', 'w') {}
+File.open('nmake.bat', 'w') { |f| }
+
+# add the gem to load path
+$: << File.expand_path("../../../lib", __FILE__)
+
+# load the command
+require 'rubygems'
+require 'nlmt-wrappers/command'
+
+# call the actions
+command = WrappersCommand.new
+command.options[:args] = ['regenerate']
+command.execute
+
+# unload the path, what was required stays ... but there is that much we can do
+$:.pop
+
+# just in case - it worked
+true

data/ext/wrapper_generator/make

@@ -0,0 +1 @@
+#!/bin/sh

data/lib/nlmt-wrappers.rb

@@ -0,0 +1,80 @@
+require 'rbconfig'
+require 'nlmt-wrappers/environment'
+require 'nlmt-wrappers/installer'
+
+module NlmtWrappers
+  class Exception < Gem::Exception ; end
+  class NoWrapper < Exception ; end
+
+  def self.environment
+    @environment ||= NlmtWrappers::Environment.new
+  end
+
+  def self.installer
+    @installer ||= NlmtWrappers::Installer.new(environment_file)
+  end
+
+  def self.install(executables)
+    environment.ensure
+    installer.ensure
+
+    # gem executables
+    executables.each do |executable|
+      installer.install(executable)
+    end
+
+    ruby_executables.each do |executable|
+      installer.install(executable)
+    end
+  end
+
+  def self.uninstall(executables)
+    # gem executables
+    executables.each do |executable|
+      installer.uninstall(executable)
+    end
+  end
+
+  def self.wrappers_path
+    installer.wrappers_path
+  end
+
+  def self.wrapper_path(exe)
+    file = File.join(wrappers_path, exe)
+    if executable?(file)
+      file
+    else
+      raise NlmtWrappers::NoWrapper, "No wrapper: #{file}"
+    end
+  end
+
+  def self.installed_wrappers
+    executables_in_directory(wrappers_path).sort.uniq
+  end
+
+  def self.gems_executables
+    # do not use map(&:...) - for ruby 1.8.6 compatibility
+    @executables ||= NlmtWrappers::Specification.installed_gems.map{|gem| gem.executables }.inject{|sum, n| sum + n }.uniq || []
+  end
+
+  def self.environment_file
+    environment.file_name
+  end
+
+  def self.ruby_executables
+    executables_in_directory(RbConfig::CONFIG["bindir"].sub(/\/+\z/, ''))
+  end
+  private_class_method :ruby_executables
+
+  def self.executables_in_directory(dir)
+    Dir.entries(dir).select do |file|
+      executable?(File.join(dir, file))
+    end
+  end
+  private_class_method :executables_in_directory
+
+  def self.executable?(path)
+    !File.directory?(path) && File.executable?(path)
+  end
+  private_class_method :executable?
+end

data/lib/nlmt-wrappers/command.rb

@@ -0,0 +1,76 @@
+require 'rubygems/command_manager'
+require 'rubygems/installer'
+require 'rubygems/version'
+require 'nlmt-wrappers'
+require 'nlmt-wrappers/specification'
+
+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
+    args = options[:args] || []
+    subcommand = args.shift || ''
+    case subcommand
+    when '', 'show'
+      args.empty? ? execute_show : execute_show_path(args.first)
+    when 'regenerate'
+      execute_regenerate(args)
+    when FileExist
+      execute_regenerate([File.expand_path(subcommand)])
+    else
+      execute_unknown subcommand
+    end
+  end
+
+  def execute_show_path(exe)
+    $stdout.puts gem_wrappers.wrapper_path(exe)
+  end
+
+  def execute_show
+    list = gem_wrappers.installed_wrappers
+    $stdout.puts description
+    $stdout.puts "   Wrappers path: #{gem_wrappers.wrappers_path}"
+    $stdout.puts "Environment file: #{gem_wrappers.environment_file}"
+    $stdout.puts "     Executables: #{list.join(", ")}"
+  end
+
+  def execute_unknown(subcommand)
+    $stderr.puts "Unknown wrapper subcommand: #{subcommand}"
+    $stdout.puts description
+    false
+  end
+
+  def execute_regenerate(list = [])
+    list = gem_wrappers.gems_executables if list.empty?
+    execute_show(list) if ENV['GEM_WRAPPERS_DEBUG']
+    gem_wrappers.install(list)
+  end
+
+private
+
+  def gem_wrappers
+    @gem_wrappers ||= NlmtWrappers
+  end
+end
+
+require 'nlmt-wrappers/command/file_exist'