manpages 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 836087ab188069543a0d1bf8a428bab0068df271
-  data.tar.gz: b6927431e0f94f8347dad3d27dd01648a61fed4d
+  metadata.gz: 88713453a394e93be00536e4ea25d068aed8e407
+  data.tar.gz: a5543a28271ab62d36ecfd9ab110849ab5e74228
 SHA512:
-  metadata.gz: 6eb39868aff19cf9a68c1eb47afa29e670ee80d4f52bc03f497de85eb48cb6a4a351ff858a3a4807209ac68b3679c9080bc28b170edca8dd2eb0959fd1f97b74
-  data.tar.gz: 8d6593ba5828ebc76721be716fa0e781650834b26de6458f86683a567a0210fea448751d8b27e2d4062fd73164b500f0815ee77145954abd17d032544f4796ff
+  metadata.gz: 5d9efae3bd6c9b240ccf0be50478bcef825328781ac92d5263a82e424299f3d5d8d1d5c47993d70915128b8598aaa31f1ad442449b7ffa5e9e6778ac85db3e48
+  data.tar.gz: bb69e48ef80123442e11d6ff2cbe3cfc4e545b44a4b60d88b31ba031a8895d4fa881686f5c96fe9439d5f99212d1fcdc98dabfbdc6858eefae570a0b279c04c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    manpages (0.3.2)
+    manpages (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,15 +1,16 @@
 # 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?maxAge=2592000)](https://rubygems.org/gems/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 `MANPATH` depending on the ruby version currently used.
+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
 
@@ -21,11 +22,21 @@ exposes them to the `man` command.
 
 # Using this with rbenv
 
-Sadly rbenv uses shims to hide the actual executables. This makes it impossible for
-man to find the pages. The only solution is to add hooks that modify the `MANPATH`
-environment variable.
+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 will [soon](https://github.com/bitboxer/manpages/issues/2) provide a hook to fix this problem.
+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
 

data/lib/manpages/version.rb

@@ -1,3 +1,3 @@
 module Manpages
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

data/manpages.gemspec

@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
   spec.email         = ["bodo@tasche.me"]
 
   spec.summary       = "Adds support for man pages to rubygems"
-  spec.description   = "This is a little experiment that adds man pages support 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)/})
+    f.match(%r{^(test|spec|features|Gemfile|Gemfile.lock)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }

data/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/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/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/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/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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manpages
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Bodo Tasche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.44.1
-description: This is a little experiment that adds man pages support to rubygems
+description: With this gem the rubygems command will detect man pages within gems
+  and exposes them to the man command.
 email:
 - bodo@tasche.me
 executables: []
@@ -106,6 +107,11 @@ files:
 - lib/manpages/version.rb
 - lib/rubygems_plugin.rb
 - manpages.gemspec
+- rbenv/hooks/install-man.bash
+- rbenv/hooks/version-name-change-man.bash
+- rbenv/rbenv_hook_install.sh
+- rbenv/remove_hook_folders.sh
+- rbenv/vars.sh
 homepage: https://github.com/bitboxer/manpages
 licenses:
 - MIT