manpages 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48917ea5351910664e322885c4d4467a064775cf
-  data.tar.gz: 97675264536cbdc896d9de852436bcd8f354f7b6
+  metadata.gz: 21e36c15f7ec3120e81a728ea1e6e17c3ee63da1
+  data.tar.gz: fa166fe6763c98a8e19985615b99ddae2a122d3e
 SHA512:
-  metadata.gz: 2ad744d3592e6d7e88e7189f1eb7fb425f6eea69c11bedb263659ec9bdb955c68726687049a54f17e9d795559384410d26ee38b8101175e564efc4be0d3746dc
-  data.tar.gz: 228abcb34f4219c4853a6b79ad8d9c333b429abdee5682d7e8ef304668e22b6693ce43e6f23397b47ad2342fe285596a11efe746029af38678e1f027aeebc275
+  metadata.gz: 1944db02ad4a705a23157e13a305b159d33a26a522a243c375d0b6856f1ac5b5a315243a6afe65dc65c4f92f0dbdbc6ff476ac0d309e831602facaf46996b93b
+  data.tar.gz: 231a6acb8428e0c465ccaff04b19f87e268527558f5364f65f1de0697dd3a30d30e323349ca7b1707ead1353a59a253ae7e816dd8897b57a4055b19068755c33

data/Gemfile.lock

@@ -1,13 +1,18 @@
 PATH
   remote: .
   specs:
-    manpages (0.1.0)
+    manpages (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.1)
     diff-lcs (1.2.5)
-    minitest (5.9.1)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -22,6 +27,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    slop (3.6.0)
 
 PLATFORMS
   ruby
@@ -29,7 +35,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.8)
   manpages!
-  minitest (~> 5.0)
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,14 +1,14 @@
 # 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)]()
 
 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 place that the `man` command can find.
 
-With rvm it works out of the box, but sadly this means that for rbenv we
-need to add hooks that 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 modify the `MANPATH` depending on the ruby version currently used.
 
 # Installation
 
@@ -28,4 +28,9 @@ simply use `man guard` and you will see the man page the gem provided.
 
 # Using this with rbenv
 
-...coming soon
+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.
+
+This gem will provide a hook soon to fix this issue.
+

data/lib/manpages.rb

@@ -1,5 +1,7 @@
 require "manpages/version"
 require "manpages/install"
+require "manpages/uninstall"
+require "manpages/man_files"
 
 module Manpages
 

data/lib/manpages/install.rb

@@ -8,7 +8,7 @@ module Manpages
     end
 
     def install_manpages
-      manpages.each do |file|
+      ManFiles.new(@gem_dir, @target_dir).manpages.each do |file|
         link_manpage(file)
       end
     end
@@ -16,21 +16,9 @@ module Manpages
     private
 
     def link_manpage(file)
-      man_dir = File.join(@target_dir, "man#{File.extname(file)[1..-1]}")
-      FileUtils.mkdir_p(man_dir)
-      FileUtils.ln_s(file, man_dir, force: true)
-    end
-
-    def manpages
-      return [] unless File.directory?(man_dir)
-
-      Dir.entries(man_dir).select do |file|
-        file =~ /(.+).\d$/
-      end.map {|file| File.join(man_dir, file) }
-    end
-
-    def man_dir
-      @man_dir ||= File.join(@gem_dir, 'man')
+      man_target_file = ManFiles.new(@gem_dir, @target_dir).man_file_path(file)
+      FileUtils.mkdir_p(File.dirname(man_target_file))
+      FileUtils.ln_s(file, man_target_file, force: true)
     end
 
   end

data/lib/manpages/man_files.rb

@@ -0,0 +1,28 @@
+module Manpages
+  class ManFiles
+
+    def initialize(gem_dir, target_dir)
+      @gem_dir    = gem_dir
+      @target_dir = target_dir
+    end
+
+    def manpages
+      return [] unless File.directory?(man_dir)
+
+      Dir.entries(man_dir).select do |file|
+        file =~ /(.+).\d$/
+      end.map {|file| File.join(man_dir, file) }
+    end
+
+    def man_dir
+      @man_dir ||= File.join(@gem_dir, 'man')
+    end
+
+    def man_file_path(file)
+      basename = File.basename(file)
+      man_section = file.match(/.*\.(\d*)/)
+      File.join(@target_dir, "man#{man_section[1]}", basename)
+    end
+
+  end
+end

data/lib/manpages/uninstall.rb

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

data/lib/manpages/version.rb

@@ -1,3 +1,3 @@
 module Manpages
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rubygems_plugin.rb

@@ -9,3 +9,10 @@ Gem.post_install do |installer|
 
   Manpages::Install.new(source_dir, target_dir).install_manpages
 end
+
+Gem.post_uninstall do |uninstaller|
+  source_dir = uninstaller.spec.gem_dir
+  target_dir = File.join(uninstaller.bin_dir, "../share/man")
+
+  Manpages::Uninstall.new(source_dir, target_dir).uninstall_manpages
+end

data/manpages.gemspec

@@ -23,6 +23,5 @@ Gem::Specification.new do |spec|
   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 "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manpages
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bodo Tasche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 description: This is a little experiment that adds man pages support to rubygems
 email:
 - bodo@tasche.me
@@ -83,6 +83,8 @@ files:
 - Rakefile
 - lib/manpages.rb
 - lib/manpages/install.rb
+- lib/manpages/man_files.rb
+- lib/manpages/uninstall.rb
 - lib/manpages/version.rb
 - lib/rubygems/commands/manpages_command.rb
 - lib/rubygems_plugin.rb
@@ -112,4 +114,3 @@ signing_key:
 specification_version: 4
 summary: Adds support for man pages to rubygems
 test_files: []
-has_rdoc: