manpages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48917ea5351910664e322885c4d4467a064775cf
+  data.tar.gz: 97675264536cbdc896d9de852436bcd8f354f7b6
+SHA512:
+  metadata.gz: 2ad744d3592e6d7e88e7189f1eb7fb425f6eea69c11bedb263659ec9bdb955c68726687049a54f17e9d795559384410d26ee38b8101175e564efc4be0d3746dc
+  data.tar.gz: 228abcb34f4219c4853a6b79ad8d9c333b429abdee5682d7e8ef304668e22b6693ce43e6f23397b47ad2342fe285596a11efe746029af38678e1f027aeebc275

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bodo@wannawork.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    manpages (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    minitest (5.9.1)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.8)
+  manpages!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Bodo Tasche
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Manpages
+
+[![Build Status](https://travis-ci.org/bitboxer/manpages.svg?branch=master)](https://travis-ci.org/bitboxer/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 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.
+
+# Installation
+
+`gem install manpages`
+
+This plugin automatically hooks into the ruby gems system.
+
+# How this works
+
+After a gem is installed, this plugin will check for a directory called `man` and
+will 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. So if you install a gem that includes a man page (e.g. guard), you can
+simply use `man guard` and you will see the man page the gem provided.
+
+# Using this with rbenv
+
+...coming soon

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/manpages.rb

@@ -0,0 +1,6 @@
+require "manpages/version"
+require "manpages/install"
+
+module Manpages
+
+end

data/lib/manpages/install.rb

@@ -0,0 +1,38 @@
+module Manpages
+
+  class Install
+
+    def initialize(gem_dir, target_dir)
+      @gem_dir    = gem_dir
+      @target_dir = target_dir
+    end
+
+    def install_manpages
+      manpages.each do |file|
+        link_manpage(file)
+      end
+    end
+
+    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')
+    end
+
+  end
+
+end

data/lib/manpages/version.rb

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

data/lib/rubygems/commands/manpages_command.rb

@@ -0,0 +1,15 @@
+class Gem::Commands::ManpagesCommand < Gem::Command
+  def initialize
+    super("manpages", "Add a description here")
+  end
+
+  def execute
+    # TODO: Add command to install
+    #   to rbenv and rvm
+
+
+    # here goes the code that will be executed
+    # when someone runs "gem manpages"
+    say "It works!"
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,11 @@
+require 'rubygems/command_manager'
+require 'manpages'
+
+Gem::CommandManager.instance.register_command(:manpages)
+
+Gem.post_install do |installer|
+  source_dir = installer.spec.gem_dir
+  target_dir = File.join(installer.bin_dir, "../share/man")
+
+  Manpages::Install.new(source_dir, target_dir).install_manpages
+end

data/manpages.gemspec

@@ -0,0 +1,28 @@
+# 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   = "This is a little experiment that adds man pages support to rubygems"
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/bitboxer/manpages"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: manpages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bodo Tasche
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: This is a little experiment that adds man pages support to rubygems
+email:
+- bodo@tasche.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/manpages.rb
+- lib/manpages/install.rb
+- lib/manpages/version.rb
+- lib/rubygems/commands/manpages_command.rb
+- lib/rubygems_plugin.rb
+- manpages.gemspec
+homepage: https://github.com/bitboxer/manpages
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Adds support for man pages to rubygems
+test_files: []
+has_rdoc: