manpages 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7896e3cea74abf59bbb5f95226a23f8d77277fc9
-  data.tar.gz: 839b7ec2bae6864689c16716c80485aad8e8f349
+  metadata.gz: 836087ab188069543a0d1bf8a428bab0068df271
+  data.tar.gz: b6927431e0f94f8347dad3d27dd01648a61fed4d
 SHA512:
-  metadata.gz: 6a5757dd8e0f4f1bf54237e77f2171847923ac0fd80840d7c3b5038ad9b346d5cc66cd942f2736c49217d3251854cdef4b0504d0e04904cd84820ba1b84633f1
-  data.tar.gz: 4f2a6fd39f99369effbb68d56dbe3ea0e9dfef21b50ac27c79320ee7b59d90e85b283b5bccd1e87c0f534ec86d2abaa95631f1802efb42a1ea399f7f8b3d4aac
+  metadata.gz: 6eb39868aff19cf9a68c1eb47afa29e670ee80d4f52bc03f497de85eb48cb6a4a351ff858a3a4807209ac68b3679c9080bc28b170edca8dd2eb0959fd1f97b74
+  data.tar.gz: 8d6593ba5828ebc76721be716fa0e781650834b26de6458f86683a567a0210fea448751d8b27e2d4062fd73164b500f0815ee77145954abd17d032544f4796ff

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,123 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 1.9
+  Exclude:
+    - tmp/**/*
+    - lib/bundler/vendor/**/*
+    - vendor/bundle/**/*
+  DisplayCopNames: true
+
+# Lint
+
+# They are idiomatic
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Style
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+# We adopted raise instead of fail.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Having these make it easier to *not* forget to add one when adding a new
+# value and you can simply copy the previous line.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+# `String.new` is preferred style with enabled frozen string literal
+Style/EmptyLiteral:
+  Enabled: false
+
+# 1.8.7 support
+
+Style/Lambda:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Performance/FlatMap:
+  Enabled: false
+
+# Metrics
+
+# We've chosen to use Rubocop only for style, and not for complexity or quality checks.
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+# It will be obvious which code is complex, Rubocop should only lint simple
+# rules for us.
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,248 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-07-27 12:41:39 -0500 using RuboCop version 0.41.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Lint/Eval:
+  Exclude:
+    - 'lib/bundler.rb'
+    - 'lib/bundler/endpoint_specification.rb'
+    - 'spec/support/streams.rb'
+
+# Offense count: 4
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/bundler/installer.rb'
+    - 'lib/bundler/psyched_yaml.rb'
+    - 'lib/bundler/vendored_persistent.rb'
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/bundler/settings.rb'
+
+# Offense count: 3
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/bundler/inline.rb'
+    - 'spec/support/builders.rb'
+
+# Offense count: 5
+Lint/RescueException:
+  Exclude:
+    - 'lib/bundler/cli.rb'
+    - 'lib/bundler/dsl.rb'
+    - 'lib/bundler/friendly_errors.rb'
+    - 'lib/bundler/rubygems_integration.rb'
+    - 'lib/bundler/worker.rb'
+
+# Offense count: 1
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/bundler/fetcher.rb'
+
+# Offense count: 6
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/bundler/index.rb'
+    - 'lib/bundler/installer.rb'
+
+# Offense count: 1686
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 207
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 6
+# Cop supports --auto-correct.
+Performance/RedundantBlockCall:
+  Exclude:
+    - 'lib/bundler/dsl.rb'
+    - 'lib/bundler/gem_helper.rb'
+    - 'lib/bundler/retry.rb'
+    - 'lib/bundler/shared_helpers.rb'
+    - 'spec/support/helpers.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Performance/RedundantMatch:
+  Exclude:
+    - 'lib/bundler/definition.rb'
+    - 'lib/bundler/lockfile_parser.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: MaxKeyValuePairs.
+Performance/RedundantMerge:
+  Exclude:
+    - 'lib/bundler/cli/gem.rb'
+    - 'spec/support/helpers.rb'
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/bundler/source/git.rb'
+
+# Offense count: 3
+Style/CaseEquality:
+  Exclude:
+    - 'lib/bundler/dsl.rb'
+    - 'lib/bundler/match_platform.rb'
+    - 'lib/bundler/rubygems_ext.rb'
+
+# Offense count: 23
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/bundler/cli.rb'
+    - 'lib/bundler/cli/gem.rb'
+    - 'lib/bundler/cli/lock.rb'
+    - 'lib/bundler/cli/platform.rb'
+    - 'lib/bundler/dsl.rb'
+    - 'lib/bundler/lazy_specification.rb'
+    - 'lib/bundler/psyched_yaml.rb'
+    - 'lib/bundler/rubygems_integration.rb'
+    - 'lib/bundler/source/git.rb'
+    - 'lib/bundler/source/rubygems.rb'
+
+# Offense count: 138
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Style/ExtraSpacing:
+  Exclude:
+    - 'lib/bundler/cli.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'lib/bundler/cli.rb'
+    - 'spec/spec_helper.rb'
+    - 'spec/support/helpers.rb'
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/bundler/cli/install.rb'
+
+# Offense count: 1
+Style/IfUnlessModifierOfIfUnless:
+  Exclude:
+    - 'spec/support/helpers.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_brackets
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: module_function, extend_self
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/bundler/shared_helpers.rb'
+    - 'spec/support/path.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Style/MultilineMethodCallIndentation:
+  Exclude:
+    - 'lib/bundler/cli/common.rb'
+    - 'spec/bundler/plugin/source_list_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/NestedParenthesizedCalls:
+  Exclude:
+    - 'lib/bundler/resolver.rb'
+    - 'spec/commands/lock_spec.rb'
+    - 'spec/runtime/setup_spec.rb'
+
+# Offense count: 9
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/bundler/definition.rb'
+    - 'lib/bundler/installer/parallel_installer.rb'
+    - 'lib/bundler/settings.rb'
+    - 'lib/bundler/source/git.rb'
+    - 'lib/bundler/source/git/git_proxy.rb'
+    - 'lib/bundler/source/path.rb'
+
+# Offense count: 25
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantParentheses:
+  Exclude:
+    - 'lib/bundler/cli/console.rb'
+    - 'lib/bundler/dsl.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/SpaceAroundOperators:
+  Exclude:
+    - 'lib/bundler/retry.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+# SupportedStyles: comma, consistent_comma, no_comma
+Style/TrailingCommaInLiteral:
+  Exclude:
+    - 'lib/bundler/cli/gem.rb'
+    - 'lib/bundler/dependency.rb'
+    - 'lib/bundler/fetcher.rb'
+    - 'lib/bundler/gem_helpers.rb'
+    - 'lib/bundler/graph.rb'
+    - 'lib/bundler/ruby_version.rb'
+    - 'lib/bundler/similarity_detector.rb'
+    - 'spec/support/artifice/endpoint.rb'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+Style/UnneededInterpolation:
+  Exclude:
+    - 'lib/bundler/cli/config.rb'
+    - 'lib/bundler/env.rb'
+    - 'spec/bundler/shared_helpers_spec.rb'
+    - 'spec/cache/git_spec.rb'
+    - 'spec/commands/exec_spec.rb'
+    - 'spec/support/artifice/endpoint.rb'
+    - 'spec/support/artifice/endpoint_500.rb'
+    - 'spec/support/fakeweb/windows.rb'

data/Gemfile

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

data/Gemfile.lock

@@ -6,13 +6,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.3.0)
     coderay (1.1.1)
     diff-lcs (1.2.5)
     method_source (0.8.2)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    rainbow (2.1.0)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -27,7 +32,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    rubocop (0.44.1)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     slop (3.6.0)
+    unicode-display_width (1.1.1)
 
 PLATFORMS
   ruby
@@ -38,6 +51,7 @@ DEPENDENCIES
   pry (~> 0)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.44.1)
 
 BUNDLED WITH
    1.13.6

data/Rakefile

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

data/lib/manpages.rb

@@ -5,5 +5,4 @@ require "manpages/man_files"
 require "manpages/gem_version"
 
 module Manpages
-
 end

data/lib/manpages/gem_version.rb

@@ -1,24 +1,21 @@
 module Manpages
-
   class GemVersion
-
     def initialize(gem_spec)
       @gem_spec = gem_spec
     end
 
-    def is_latest?
+    def latest?
       latest_gem.nil? || latest_gem <= @gem_spec.version
     end
 
-    private
+  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)
+      Gem::Specification.each.select {|spec| @gem_spec.name == spec.name }.map(&:version)
     end
-
   end
 end

data/lib/manpages/install.rb

@@ -1,7 +1,5 @@
 module Manpages
-
   class Install
-
     def initialize(gem_spec, gem_dir, target_dir)
       @gem_spec   = gem_spec
       @gem_dir    = gem_dir
@@ -9,10 +7,10 @@ module Manpages
     end
 
     def install_manpages
-      link_manpages if GemVersion.new(@gem_spec).is_latest?
+      link_manpages if GemVersion.new(@gem_spec).latest?
     end
 
-    private
+  private
 
     def link_manpages
       ManFiles.new(@gem_dir, @target_dir).manpages.each do |file|
@@ -22,16 +20,14 @@ module Manpages
 
     def link_manpage(file)
       man_target_file = ManFiles.new(@gem_dir, @target_dir).man_file_path(file)
-      return if File.exist? man_target_file
+      return if man_target_file.exist?
 
       begin
-        FileUtils.mkdir_p(File.dirname(man_target_file))
+        FileUtils.mkdir_p(man_target_file.dirname)
         FileUtils.ln_s(file, man_target_file, force: true)
-      rescue => e
+      rescue
         puts "Problems creating symlink #{man_target_file}"
       end
     end
-
   end
-
 end

data/lib/manpages/man_files.rb

@@ -1,28 +1,25 @@
+require "pathname"
+
 module Manpages
   class ManFiles
+    attr_reader :man_dir
 
     def initialize(gem_dir, target_dir)
-      @gem_dir    = gem_dir
-      @target_dir = target_dir
+      @target_dir = Pathname(target_dir)
+      @man_dir = Pathname(File.join(gem_dir, "man"))
     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
+      return [] unless man_dir.directory?
 
-    def man_dir
-      @man_dir ||= File.join(@gem_dir, 'man')
+      man_dir.children(false).select do |file|
+        file.extname =~ /.\d$/
+      end.map {|file| man_dir.join(file) }
     end
 
     def man_file_path(file)
-      basename = File.basename(file)
-      man_section = file.match(/.*\.(\d*)/)
-      File.join(@target_dir, "man#{man_section[1]}", basename)
+      man_section = file.extname.match(/\.(\d*)/)
+      @target_dir.join("man#{man_section[1]}", file.basename)
     end
-
   end
 end

data/lib/manpages/uninstall.rb

@@ -1,7 +1,5 @@
 module Manpages
-
   class Uninstall
-
     def initialize(gem_spec, gem_dir, target_dir)
       @gem_spec   = gem_spec
       @gem_dir    = gem_dir
@@ -9,10 +7,10 @@ module Manpages
     end
 
     def uninstall_manpages
-      unlink_manpages if GemVersion.new(@gem_spec).is_latest?
+      unlink_manpages if GemVersion.new(@gem_spec).latest?
     end
 
-    private
+  private
 
     def unlink_manpages
       ManFiles.new(@gem_dir, @target_dir).manpages.each do |file|
@@ -22,10 +20,8 @@ module Manpages
 
     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
+      FileUtils.rm(man_target_file) if man_target_file.symlink? &&
+          man_target_file.readlink == file
     end
-
   end
 end

data/lib/manpages/version.rb

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

data/lib/rubygems_plugin.rb

@@ -1,7 +1,4 @@
-require 'rubygems/command_manager'
-require 'manpages'
-
-Gem::CommandManager.instance.register_command(:manpages)
+require "manpages"
 
 Gem.post_install do |installer|
   source_dir = installer.spec.gem_dir

data/manpages.gemspec

@@ -1,8 +1,8 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'manpages/version'
+require "manpages/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "manpages"
@@ -15,13 +15,16 @@ Gem::Specification.new do |spec|
   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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 "pry", "~> 0"
+  spec.add_development_dependency "rubocop", "~> 0.44.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manpages
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Bodo Tasche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
 description: This is a little experiment that adds man pages support to rubygems
 email:
 - bodo@tasche.me
@@ -74,6 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile