ric 0.12.0 → 0.14.1

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/README.md

@@ -0,0 +1,65 @@
+# Manpages
+
+[![Build Status](https://travis-ci.org/bitboxer/manpages.svg?branch=master)](https://travis-ci.org/bitboxer/manpages)
+[![Gem](https://img.shields.io/gem/v/manpages.svg)](https://rubygems.org/gems/manpages)
+
+This plugin will add man pages support to ruby gems. Instead 
+of adding a new command like [gem-man](https://github.com/defunkt/gem-man)
+it will try to link the files to a place the `man` command automatically
+discovers.
+
+With rvm and chruby it works out of the box, but sadly for rbenv we need to
+[add hooks that](#using-this-with-rbenv) modify the `man` symlink depending on
+the ruby version currently used.
+
+# Installation
+
+`gem install manpages && gem manpages --update-all`
+
+This plugin automatically hooks into the ruby gems system. Every gem
+installed afterwards is checked for manpages. If this gem finds them, it
+exposes them to the `man` command.
+
+# Using this with rbenv
+
+Sadly rbenv uses shims to hide the actual executables. This makes it a bit
+harder to make this gem work in that environment.
+
+This gem provides hooks to change the man path for the current used ruby version.
+To install them execute the following line:
+
+```
+curl -o- https://raw.githubusercontent.com/bitboxer/manpages/master/rbenv/rbenv_hook_install.sh | bash
+```
+
+After the hooks are installed, rbenv will always change the man symlink to the
+currently used ruby version. Sadly rbenv does not provide a hook that is fired
+when switching ruby versions. This means that the path can only be corrected
+when executing a command provided by a gem. If you want to have the correct
+man page for a gem, you need to execute the command of that gem, first.
+
+# How this works
+
+After a gem is installed, this plugin will check for a directory called `man` within the 
+gem and link the manpages it finds to `BIN_DIR/../share/man`, where `BIN_DIR` is the
+directory where the executable of the gem is installed.
+
+Most man versions will automatically search this directory and no additional work
+is required. If you install a gem that includes a man page (e.g. [guard](https://github.com/guard/guard)), you can
+simply use `man guard` and you will see the man page the gem provided.
+
+# Providing man pages with your gem
+
+The most common way in the ruby world to create a man page is through a tool
+called [ronn](https://github.com/rtomayko/ronn#readme). Ronn uses a modified
+variant of markdown as source file. More details about the format can be found
+[here](https://github.com/rtomayko/ronn/blob/master/man/ronn-format.7.ronn).
+In the newest version [kramdown](http://kramdown.gettalong.org/converter/man.html) also
+is able to generate man pages.
+
+Make sure the resulting manpage is in a folder called `man` in the root of the
+gem. Files stored in that directory will automatically be exposed to the
+`man` command.
+
+Examples for gems with manpages are [guard](https://github.com/guard/guard/tree/master/man) or
+[gem-man](https://github.com/defunkt/gem-man/tree/master/man).

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:rubocop, :spec]

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages/gem_version.rb

@@ -0,0 +1,21 @@
+module Manpages
+  class GemVersion
+    def initialize(gem_spec)
+      @gem_spec = gem_spec
+    end
+
+    def latest?
+      latest_gem.nil? || latest_gem <= @gem_spec.version
+    end
+
+  private
+
+    def latest_gem
+      all_gem_versions.sort.last
+    end
+
+    def all_gem_versions
+      Gem::Specification.each.select {|spec| @gem_spec.name == spec.name }.map(&:version)
+    end
+  end
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages/install.rb

@@ -0,0 +1,35 @@
+require "fileutils"
+
+module Manpages
+  class Install
+    def initialize(gem_spec, gem_dir, target_dir)
+      @gem_spec   = gem_spec
+      @gem_dir    = gem_dir
+      @target_dir = target_dir
+    end
+
+    def install_manpages
+      link_manpages if GemVersion.new(@gem_spec).latest?
+    end
+
+  private
+
+    def link_manpages
+      ManFiles.new(@gem_dir, @target_dir).manpages.each do |file|
+        link_manpage(file)
+      end
+    end
+
+    def link_manpage(file)
+      man_target_file = ManFiles.new(@gem_dir, @target_dir).man_file_path(file)
+      return if man_target_file.exist?
+
+      begin
+        FileUtils.mkdir_p(man_target_file.dirname)
+        FileUtils.ln_s(file, man_target_file, force: true)
+      rescue
+        puts "Problems creating symlink #{man_target_file}"
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages/man_files.rb

@@ -0,0 +1,29 @@
+require "pathname"
+
+module Manpages
+  class ManFiles
+    attr_reader :man_dir
+
+    def initialize(gem_dir, target_dir = "")
+      @target_dir = Pathname(target_dir)
+      @man_dir = Pathname(File.join(gem_dir, "man"))
+    end
+
+    def manpages_present?
+      !manpages.empty?
+    end
+
+    def manpages
+      return [] unless man_dir.directory?
+
+      Dir[man_dir.join("**/*")].select do |file|
+        file =~ /\.\d$/
+      end.map {|file| Pathname.new(file) }
+    end
+
+    def man_file_path(file)
+      man_section = file.extname.match(/\.(\d*)/)
+      @target_dir.join("man#{man_section[1]}", file.basename)
+    end
+  end
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages/uninstall.rb

@@ -0,0 +1,27 @@
+module Manpages
+  class Uninstall
+    def initialize(gem_spec, gem_dir, target_dir)
+      @gem_spec   = gem_spec
+      @gem_dir    = gem_dir
+      @target_dir = target_dir
+    end
+
+    def uninstall_manpages
+      unlink_manpages if GemVersion.new(@gem_spec).latest?
+    end
+
+  private
+
+    def unlink_manpages
+      ManFiles.new(@gem_dir, @target_dir).manpages.each do |file|
+        unlink_manpage(file)
+      end
+    end
+
+    def unlink_manpage(file)
+      man_target_file = ManFiles.new(@gem_dir, @target_dir).man_file_path(file)
+      FileUtils.rm(man_target_file) if man_target_file.symlink? &&
+          man_target_file.readlink == file
+    end
+  end
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages/version.rb

@@ -0,0 +1,3 @@
+module Manpages
+  VERSION = "0.6.1".freeze
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/manpages.rb

@@ -0,0 +1,8 @@
+require "manpages/version"
+require "manpages/install"
+require "manpages/uninstall"
+require "manpages/man_files"
+require "manpages/gem_version"
+
+module Manpages
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/rubygems/commands/manpages_command.rb

@@ -0,0 +1,45 @@
+class Gem::Commands::ManpagesCommand < Gem::Command
+  include Gem::VersionOption
+
+  def initialize
+    super "manpages", "Handling manpages in gems",
+      command: nil,
+      version: Gem::Requirement.default,
+      latest:  false,
+      all:     false
+
+    add_update_all_option
+  end
+
+  def usage
+    "gem manpages"
+  end
+
+  def add_update_all_option
+    add_option("-u", "--update-all",
+      "Search for manpages in all installed gems and expose them to man") do |_, options|
+      options[:update_all] = true
+    end
+  end
+
+  def execute
+    if options[:update_all]
+      update_all
+    else
+      show_help
+    end
+  end
+
+  def update_all
+    specs = Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.gems
+    specs.each do |*name_and_spec|
+      spec = name_and_spec.pop
+      next unless Manpages::ManFiles.new(spec.gem_dir).manpages_present? &&
+          Manpages::GemVersion.new(spec).latest?
+
+      say "Installing man pages for #{spec.name} #{spec.version}"
+      target_dir = File.expand_path("#{Gem.bindir}/../share/man")
+      Manpages::Install.new(spec, spec.gem_dir, target_dir).install_manpages
+    end
+  end
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/lib/rubygems_plugin.rb

@@ -0,0 +1,20 @@
+require "manpages"
+require "rubygems/command_manager"
+require "rubygems/version_option"
+
+Gem::CommandManager.instance.register_command :manpages
+
+Gem.post_install do |installer|
+  source_dir = installer.spec.gem_dir
+  target_dir = File.expand_path("#{installer.bin_dir}/../share/man")
+
+  Manpages::Install.new(installer.spec, source_dir, target_dir).install_manpages
+end
+
+Gem.pre_uninstall do |uninstaller|
+  bin_dir = uninstaller.bin_dir || Gem.bindir(uninstaller.spec.base_dir)
+  source_dir = uninstaller.spec.gem_dir
+  target_dir = File.expand_path("#{bin_dir}/../share/man")
+
+  Manpages::Uninstall.new(uninstaller.spec, source_dir, target_dir).uninstall_manpages
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/manpages.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "manpages/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "manpages"
+  spec.version       = Manpages::VERSION
+  spec.authors       = ["Bodo Tasche"]
+  spec.email         = ["bodo@tasche.me"]
+
+  spec.summary       = "Adds support for man pages to rubygems"
+  spec.description   = "With this gem the rubygems command will detect man pages within gems and exposes them to the man command."
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/bitboxer/manpages"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|Gemfile|Gemfile.lock)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "rubocop", "~> 0.44.1"
+end

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/rbenv/hooks/install-man.bash

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+if declare -Ff after_install >/dev/null; then
+  after_install install_manpages
+else
+  echo "rbenv: rbenv-default-gems plugin requires ruby-build 20130129$"
+fi
+
+install_manpages() {
+  gem install manpages < /dev/null || {
+    echo "rbenv: error installing gem 'manpages'"
+  } >&2
+}

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/rbenv/hooks/version-name-change-man.bash

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+[ -n "$RBENV_DEBUG" ] && set -x
+
+SHARE_MAN="$(rbenv root)/share"
+ROOT_MAN="$SHARE_MAN/man"
+PREFIX_MAN="$(rbenv prefix)/share/man"
+
+if [ "$(readlink $ROOT_MAN)" != "$PREFIX_MAN" ]; then
+  [ -n "$RBENV_DEBUG" ] && echo "linking ${PREFIX_MAN} -> ${ROOT_MAN}"
+  mkdir -p $SHARE_MAN
+  ln -f -s $PREFIX_MAN $SHARE_MAN
+fi

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/rbenv/rbenv_hook_install.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+SCRIPT_DIR="$( cd "$( dirname "$0" )/../" && pwd )"
+
+if [ -z $GEM_NAME ]; then
+  GEM_NAME="manpages"
+fi
+if ! $(gem list -i "$GEM_NAME") ;then
+  gem install "$GEM_NAME"
+fi
+
+if [ -n "$(command -v git)" ] && \
+  [ "$(basename $(git config --local remote.origin.url) 2>/dev/null)" = "manpages.git" ]; then
+  DIR=$SCRIPT_DIR
+else
+  LIB_DIR="$(dirname "$(gem which manpages)")"
+  DIR="$(readlink -f  ${LIB_DIR}/../)"
+fi
+
+if [ "$DIR" != "$(rbenv root)" ]; then
+  . "${DIR}/rbenv/vars.sh"
+
+  mkdir -p "${PREFIX_MAN}"
+
+  mkdir -p $EXEC_HOOK_DIR
+  mkdir -p $INSTALL_HOOK_DIR
+
+  cp "${DIR}/rbenv/hooks/version-name-change-man.bash" $EXEC_HOOK_DIR/
+  cp "${DIR}/rbenv/hooks/install-man.bash" $INSTALL_HOOK_DIR/
+
+  ln -sf $PREFIX_MAN "${ROOT_MAN}"
+  echo "manpages gem installed"
+else
+  echo "cannot find gem folder"
+fi

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/rbenv/remove_hook_folders.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+DIR="$( cd "$( dirname "$0" )/../" && pwd )"
+
+. ${DIR}/rbenv/vars.sh
+
+echo "removing $ROOT_MAN"
+rm -rf "$ROOT_MAN"
+echo "removing $PREFIX_MAN"
+rm -rf "$PREFIX_MAN"
+echo "removing $INSTALL_HOOK_DIR"
+rm -rf "$INSTALL_HOOK_DIR"
+echo "removing $EXEC_HOOK_DIR"
+rm -rf "$EXEC_HOOK_DIR"
+
+if [ -z $GEM_NAME ]; then
+  GEM_NAME="manpages"
+fi
+
+gem uninstall "$GEM_NAME"

data/vendor/bundle/ruby/2.7.0/gems/manpages-0.6.1/rbenv/vars.sh

@@ -0,0 +1,6 @@
+RBENV_ROOT=`rbenv root`
+
+PREFIX_MAN="$(rbenv prefix)/share/man"
+ROOT_MAN="${RBENV_ROOT}/share/man"
+EXEC_HOOK_DIR="${RBENV_ROOT}/plugins/manpages/etc/rbenv.d/exec"
+INSTALL_HOOK_DIR="${RBENV_ROOT}/plugins/manpages/etc/rbenv.d/install"