nlmt-wrappers 0.0.1

data/lib/nlmt-wrappers/command/file_exist.rb

@@ -0,0 +1,7 @@
+class WrappersCommand
+  class FileExist
+    def self.===(file)
+      File.exist?(file)
+    end
+  end
+end

data/lib/nlmt-wrappers/environment.rb

@@ -0,0 +1,56 @@
+require 'erb'
+require 'fileutils'
+
+module NlmtWrappers
+  class Environment
+
+    def self.file_name
+      path = Gem.configuration && Gem.configuration[:wrappers_environment_file]
+      if path.nil? || path == ""
+        path = File.join(Gem.dir, 'environment')
+      end
+      path
+    end
+
+    def file_name
+      @file_name ||= self.class.file_name
+    end
+
+    def path_take
+      return @path_take if defined? @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_name)
+      FileUtils.mkdir_p(File.dirname(file_name)) unless File.exist?(File.dirname(file_name))
+      content = ERB.new(template).result(binding)
+      File.open(file_name, 'w') do |file|
+        file.write(content)
+      end
+      File.chmod(0644, file_name)
+    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/nlmt-wrappers/installer.rb

@@ -0,0 +1,110 @@
+require 'erb'
+require 'fileutils'
+
+module NlmtWrappers
+  class Installer
+    attr_reader :environment_file
+
+    def initialize(environment_file = nil, executable_format = Gem.default_exec_format)
+      @environment_file = environment_file
+      @executable_format = executable_format
+    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
+      unless File.writable?(wrappers_path)
+        raise Gem::FilePermissionError.new(wrappers_path)
+      end
+      unless @environment_file
+        raise "Missing environment file for initialize!"
+      end
+    end
+
+    def uninstall(executable)
+      file_name = File.join(wrappers_path, executable)
+      File.delete(file_name) if File.exist?(file_name)
+    end
+
+    def install(executable)
+      target_path = find_executable_path(executable)
+      unless target_path
+        warn "NlmtWrappers: Can not wrap missing file: #{executable}"
+        return
+      end
+      unless File.executable?(target_path)
+        warn "NlmtWrappers: Can not wrap not executable file: #{target_path}"
+        return
+      end
+      @executable = executable
+      content = ERB.new(template).result(binding)
+      install_file(executable, content)
+      install_to_formatted(executable, content)
+    end
+
+    def find_executable_path(executable)
+      return executable if File.exist?(executable)
+      ENV['PATH'].split(File::PATH_SEPARATOR).each { |dir|
+        full_path = File.join(dir, executable)
+        return full_path if File.exist?(full_path)
+      }
+      nil
+    end
+
+    def install_to_formatted(executable, content)
+      formatted_executable = @executable_format % executable
+      if
+        formatted_executable != executable
+      then
+        install_file(formatted_executable, content)
+      end
+    end
+
+    def install_file(executable, content)
+      file_name = File.join(wrappers_path, File.basename(executable))
+      File.open(file_name, 'w') do |file|
+        file.write(content)
+      end
+      file_set_executable(file_name)
+    end
+
+    def executable_expanded
+      if File.extname(@executable) == ".rb"
+      then "ruby #{@executable}"
+      else @executable
+      end
+    end
+
+    def template
+      @template ||= <<-TEMPLATE
+#!/usr/bin/env bash
+
+if
+  [[ -s "<%= environment_file %>" ]]
+then
+  source "<%= environment_file %>"
+  exec <%= executable_expanded %> "$@"
+else
+  echo "ERROR: Missing RVM environment file: '<%= environment_file %>'" >&2
+  exit 1
+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/nlmt-wrappers/specification.rb

@@ -0,0 +1,19 @@
+module NlmtWrappers
+  module Specification
+    def self.installed_gems
+      if Gem::VERSION > '1.8' then
+        Gem::Specification.to_a
+      else
+        Gem.source_index.map{|name,spec| spec}
+      end
+    end
+
+    def self.find(name = "nlmt-wrappers")
+      @gem_wrappers_spec ||= installed_gems.find{|spec| spec.name == name }
+    end
+
+    def self.version
+      find ? find.version.to_s : nil
+    end
+  end
+end

data/lib/nlmt-wrappers/version.rb

@@ -0,0 +1,3 @@
+module NlmtWrappers
+  VERSION = "0.0.1"
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,23 @@
+# Simulate require_relative - it's required as the plugin can be called in wrong version or from bundler.
+require File.expand_path('../nlmt-wrappers/specification.rb', __FILE__)
+
+called_path, called_version = __FILE__.match(/^(.*\/nlmt-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) || NlmtWrappers::Specification.version == called_version ) and
+  ( !defined?(Bundler) || ( defined?(Bundler) && Bundler::SharedHelpers.in_bundle? && !Bundler.settings[:disable_shared_gems]) )
+
+  require 'nlmt-wrappers'
+  require 'nlmt-wrappers/command'
+
+  Gem.post_install do |installer|
+    NlmtWrappers.install(installer.spec.executables)
+  end
+
+  Gem.post_uninstall do |installer|
+    NlmtWrappers.uninstall(installer.spec.executables)
+  end
+
+  Gem::CommandManager.instance.register_command :wrappers
+end

data/nlmt-wrappers.gemspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/nlmt-wrappers/version.rb", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "nlmt-wrappers"
+  s.version = NlmtWrappers::VERSION
+  s.authors = ["Shaikhraznova"]
+  s.email = ["ilmirashaikhraznova@gmail.com"]
+  s.homepage = "https://rubygems.org/gems/nlmt-wrappers"
+  s.metadata    = { "source_code_uri" => "https://github.com/angry-boss/nlmt-wrappers" }
+  s.summary = "Create gem wrappers for easy use of gems in cron and other system locations."
+  s.license = "Apache 2.0"
+  s.extensions  = %w( ext/wrapper_generator/extconf.rb )
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_development_dependency("rake", "<11")
+  s.add_development_dependency("minitest", "<6")
+  # s.add_development_dependency("smf-gem")
+end

data/test/gem-wrappers/command_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+require 'pathname'
+require 'tempfile'
+require 'nlmt-wrappers/command'
+require 'nlmt-wrappers/fakes'
+
+describe WrappersCommand do
+  subject do
+    WrappersCommand.new
+  end
+
+  let(:gems) { %w[rake ruby] }
+
+  before do
+    @fake_wrappers = NlmtWrappers::Fake.new(gems)
+    subject.instance_variable_set(:@gem_wrappers, @fake_wrappers)
+    $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
+    $stderr.string.must_equal("Unknown wrapper subcommand: wrong\n")
+    $stdout.string.must_equal(subject.description)
+  end
+
+  it "does show" do
+    subject.options[:args] = ["show"]
+    subject.execute
+
+    $stderr.string.must_equal("")
+    $stdout.string.must_match(%r{\
+#{Regexp.escape(subject.description.strip)}
+   Wrappers path: /path/to/wrappers
+Environment file: /path/to/environment
+     Executables: rake, ruby
+})
+  end
+
+  it "does show rake" do
+    subject.options[:args] = ["show", "rake"]
+    subject.execute
+
+    $stderr.string.must_equal("")
+    $stdout.string.must_equal("/path/to/wrappers/rake\n")
+  end
+
+  it "regenerates wrappers" do
+    subject.options[:args] = %w{regenerate rake}
+    subject.execute
+    @fake_wrappers.executables.must_equal(%w{rake})
+  end
+
+  describe "script wrappers" do
+    before do
+      @file = Tempfile.new('command-wrappers')
+    end
+
+    after do
+      @file.close
+      @file.unlink
+    end
+
+    it "generates script wrapper full path" do
+      subject.options[:args] = [@file.path]
+      subject.execute
+      @fake_wrappers.executables.must_equal([@file.path])
+    end
+
+    it "generates script wrapper relative" do
+      Dir.chdir(File.dirname(@file.path)) do
+        subject.options[:args] = [File.basename(@file.path)]
+        subject.execute
+        @fake_wrappers.executables.must_equal([Pathname.new(@file.path).realpath.to_s])
+      end
+    end
+  end
+end

data/test/gem-wrappers/environment_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'tempfile'
+require 'nlmt-wrappers/environment'
+
+describe NlmtWrappers::Environment do
+  describe "configuration" do
+    it "uses default file" do
+      Gem.configuration[:wrappers_environment_file] = nil
+      NlmtWrappers::Environment.file_name.must_equal(File.join(Gem.dir, "environment"))
+      NlmtWrappers::Environment.new.file_name.must_equal(NlmtWrappers::Environment.file_name)
+    end
+    it "reads configured file" do
+      Gem.configuration[:wrappers_environment_file] = "/path/to/environment"
+      NlmtWrappers::Environment.file_name.must_equal("/path/to/environment")
+      NlmtWrappers::Environment.new.file_name.must_equal("/path/to/environment")
+      Gem.configuration[:wrappers_environment_file] = nil
+    end
+    it "uses default take" do
+      Gem.configuration[:wrappers_path_take] = nil
+      NlmtWrappers::Environment.new.path_take.must_equal(Gem.path.size + 1)
+    end
+    it "reads configured take" do
+      Gem.configuration[:wrappers_path_take] = 0
+      NlmtWrappers::Environment.new.path_take.must_equal(Gem.path.size)
+      Gem.configuration[:wrappers_path_take] = nil
+    end
+  end
+
+  describe "instance" do
+    subject do
+      NlmtWrappers::Environment.new
+    end
+
+    before do
+      @test_file = Tempfile.new('environment-file')
+    end
+
+    after do
+      @test_file.close
+      @test_file.unlink if @test_file.path
+    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_name, @test_file.path)
+      File.open(subject.file_name, "w") do |file|
+        file.write("something")
+      end
+      subject.ensure
+      File.open(subject.file_name, "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_name, @test_file.path)
+      @test_file.close
+      @test_file.unlink
+      subject.ensure
+      File.open(subject.file_name, "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/fakes.rb

@@ -0,0 +1,71 @@
+module NlmtWrappers
+  class FakeInstaller
+    def initialize
+      @executables = []
+    end
+    def install(executable)
+      @executables << executable
+    end
+    def uninstall(executable)
+      @executables.delete(executable)
+    end
+    def executables
+      @executables.uniq
+    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(gems)
+      @gems = gems
+      @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
+    def wrapper_path(exe)
+      file = File.join(wrappers_path, exe)
+      if @gems.include?(exe)
+        file
+      else
+        raise NlmtWrappers::NoWrapper, "No wrapper: #{file}"
+      end
+    end
+    def installed_wrappers
+      @gems
+    end
+    def gems_executables
+      @gems
+    end
+  end
+end