bundler-why 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac50c4e539f7928944ee960faba8a98ceb9eb3f5ca06135efd684f385e81b420
-  data.tar.gz: b93ed4b008830ff44fc8138568cf6ec33fe345164eb93e1c765ecfdea6a47553
+  metadata.gz: 585f389134eb3e8429d975a06f6c65496cc072a37b23aeb566596c11a400cfcf
+  data.tar.gz: f065ca1abfb2d665e99bd6a7cb84fc1ba6ac67ff9a84484a5dc362a2a471c9f0
 SHA512:
-  metadata.gz: 6146c6debba323e2325ff5000a99e15dc3434669bfab9a83354928e7cfdf15bc9be50847bda681a3158e73b99d26047b944af78bc71019ce77b7fbe8e1b8377d
-  data.tar.gz: 0561dc31c1f1567c1d806045471f827ff08a55c40d404dc263cc09116e5aef51d38ee9c970817bd18101ba83bb7632b8ad3c77f53e5b3b831c36545804e51659
+  metadata.gz: 936c971ad9b6eea628962946d2482fcc453657a2ec46b110105e27837fb5da4649528ab1b33d326f679db68340b9b574a498899d1fd8597cecd330c2658f1b35
+  data.tar.gz: 47359fe1a40e95dab89aa4ce61ddee7bf18411f510cf16f7eece01c5724d89f3b4df5c8de7b6d9efbc3203afb8c358b688b86aaa1e1dc159b8557b62dc98bfc7

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -0,0 +1,344 @@
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# Used consistently, both leading and trailing styles are valid, but
+# Singlebrook happens to use the trailing style.
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+# This cop has a bug in 0.52.0
+# https://github.com/bbatsov/rubocop/issues/5224
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+# Indent arrays so that the first element is relative to the first position of
+# the line where the opening bracket is.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Max: 100
+
+# In a multiline method call, put the closing parenthesis on its own line.
+# The first argument may either be on the first line, or the second. Both of the
+# following are correct:
+#
+# ```
+# # A. correct
+# create(:user,
+#   client: foo,
+#   long_line: blah
+# )
+#
+# # B. also correct
+# create(
+#   :user,
+#   client: foo,
+#   long_line: blah
+# )
+#
+# # C. not preferred
+# user = create :user,
+#   client: foo,
+#   long_line: blah
+# ```
+#
+# Rubocop supports B, but not A. This project allows both, so this cop is
+# disabled.
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+# This cop has a bug in 0.83.0
+# https://github.com/rubocop-hq/rubocop/issues/7962
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - app/autoload/compliance/programs/pre_qar_to_qar/preconditions.rb
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+# Sometimes splat is convenient, sometimes unnecessary. Too subtle to lint.
+Lint/RedundantSplatExpansion:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Exclude:
+    - 'db/migrate/*'
+    - 'spec/support/assemblies/**/*'
+
+# Compared to metrics like `AbcSize` or `CyclomaticComplexity`, number of
+# lines is not a useful metric.
+Metrics/ClassLength:
+  Enabled: false
+
+# Compared to metrics like `AbcSize` or `CyclomaticComplexity`, number of
+# lines is not a useful metric.
+Metrics/BlockLength:
+  Enabled: false
+
+# Compared to metrics like `AbcSize` or `CyclomaticComplexity`, the number of
+# lines in a method is not a useful metric. It's common to have very long
+# methods (> 50 lines) which are quite simple. For example, a method that
+# returns a long string with only a few interpolations.
+Metrics/MethodLength:
+  Enabled: false
+
+# Compared to metrics like `AbcSize` or `CyclomaticComplexity`, the number of
+# lines in a module is not a useful metric.
+Metrics/ModuleLength:
+  Enabled: false
+
+# Too strict. Not all methods named `set_x` would make sense named `x=`.
+Naming/AccessorMethodName:
+  Enabled: false
+
+# It is a decades-old convention to use EOS as a heredoc delimiter. There is
+# not enough value in changinge this convention. SQL should still be used as
+# a delimiter when appropriate.
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# It is reasonable to use mathematical symbols in comments, or to relish what
+# little multilingualism we have in America by using native spellings, like
+# "façade" or "naïve".
+Style/AsciiComments:
+  Enabled: false
+
+# Giving the ivar a leading underscore implies that it should not be
+# set/referencd outside of the memoization method.
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+# Sometimes two chars, or even one, is acceptable.
+Naming/MethodParameterName:
+  Enabled: false
+
+# Use numbers wherever you like in your variables. Who cares.
+Naming/VariableNumber:
+  Enabled: false
+
+# safe_load is necessary for end-user input, and unnecessary for files
+# written by devs. The export config, for example, is written by devs.
+Security/YAMLLoad:
+  Exclude:
+    - 'app/services/clients/exporter.rb'
+
+# Use the semantic style. If a block has side effects use `do`, and if it is
+# pure use `{}`. This style is too nuanced for a linter, so the cop is
+# disabled.
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/Documentation:
+  Exclude:
+    - 'test/**/*'
+
+# Use double negation wherever it would otherwise be impractical to convert
+# a value to an actual boolean.
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/ExponentialNotation:
+  Enabled: false
+
+# Concerns:
+# 1. In 0.52.0, this complains about `strftime('%x')`. Annotating tokens in
+#    e.g. strftime would just be duplicating documenation.
+# 2. Annotating tokens in long format strings could make such lines very long.
+# 3. Annotation is not necessary in format strings with small numbers of tokens.
+Style/FormatStringToken:
+  Enabled: false
+
+# The decision of when to use a guard clause is too nuanced for a linter.
+Style/GuardClause:
+  Enabled: false
+
+# `hash.keys.each` is totally fine.
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+# Avoid postfix (aka. modifier) conditional operator, except on the simplest
+# of lines. This is too nuanced for a linter.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# When using a multiline proc in a hash (eg. `validates`), I don't want to use
+# lambda because then I'd have commas immediately after the "end", like `end,`.
+Style/Lambda:
+  Enabled: false
+
+# There is a known issue with `MixinGrouping` in rubocop 0.48.0
+# https://github.com/bbatsov/rubocop/issues/4172
+Style/MixinGrouping:
+  Enabled: false
+
+# Disabled, because we like to write tests like:
+#
+# expect(
+#   foo :bar, :baz
+# ).to # whatever
+#
+# When there's only one argument, and it's on its own line, there's no problem.
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/Next:
+  MinBodyLength: 5 # The default of 3 is too low for my taste.
+
+# This is a new cop in rubocop 0.41, and I'm not sure if I want to adopt it yet.
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+# Use `x > 0` because it is more specific than `x.positive?`.
+# However, `x.zero?` is acceptable because it is specific enough.
+Style/NumericPredicate:
+  Enabled: false
+
+# This cop complains about lovely things like:
+# `gsub(/(\w*)/) { $1.capitalize }`
+# I wouldn't want to write this differently.
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+# Disabled because it has a bug in 0.85.0
+# https://github.com/rubocop-hq/rubocop/pull/8073
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+# The decision of when to use slashes `/foo/` or percent-r `%r{foo}` is too
+# subtle to lint. Use whichever requires fewer backslash escapes.
+Style/RegexpLiteral:
+  Enabled: false
+
+# Disabled because it is overzealous in 0.50.0.
+# https://github.com/bbatsov/rubocop/issues/4731
+Style/SafeNavigation:
+  Enabled: false
+
+# The new recommendation to use `acc` and `elem` instead of `a` and `e` is fine,
+# if someone wants to change it. For now, it's fine to keep `a` and `e`.
+Style/SingleLineBlockParams:
+  Methods:
+    - reduce:
+        - a
+        - e
+    - inject:
+        - a
+        - e
+
+Style/SlicingWithRange:
+  Enabled: true
+
+# This cop wants us to use `warn` instead of `$stderr.puts` but that change
+# would be neither compatible nor desirable.
+# https://github.com/bbatsov/rubocop/issues/4888
+Style/StderrPuts:
+  Enabled: false
+
+# Use `%i[]` symbol arrays frequently, they are often good. Too subtle to lint,
+# though.
+Style/SymbolArray:
+  Enabled: false
+
+Style/SymbolProc:
+  Exclude:
+    # cancan 3.0.0 has a bug that prevents us from using symbol-to-proc
+    # https://github.com/CanCanCommunity/cancancan/issues/584
+    - app/autoload/abilities/universal.rb
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+# This cop has a bug in rubocop 0.62.0:
+# https://github.com/rubocop-hq/rubocop/issues/6627
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+# Predicate methods, aka. question-mark methods, such as `def x?; @x; end` are
+# acceptable. See https://github.com/bbatsov/rubocop/issues/2736 for discussion.
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+# Avoid postfix loops (e.g. `x until y`) except in utterly simple situations.
+# This is too nuanced for a linter.
+Style/WhileUntilModifier:
+  Enabled: false
+
+# `%w` is good, and should be used often, but it's too subtle to lint.
+# Consider the following:
+#
+# ```ruby
+# MODULE_ACTIVENESS = [
+#   ['All Modules', ''],
+#   ['Active', 'true'],
+#   ['Inactive', 'false']
+# ].freeze
+# ```
+#
+# We can't use `%w` on the first option, therefore we don't want to use it on
+# the subsequent options.
+Style/WordArray:
+  Enabled: false
+
+# We would like to use this cop, but it doesn't work in 0.49.
+Style/YodaCondition:
+  Enabled: false
+
+# Consider A and B below. A is more like normal English than B.
+#
+# ```
+# # A
+# qar_modules.length > 0 || question_assignments.length > 0
+# # B
+# !qar_modules.empty? || !question_assignments.empty?
+# ```
+Style/ZeroLengthPredicate:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
+recommendations of [keepachangelog.com](http://keepachangelog.com/).
+
+## 0.1.1
+
+### Fixed
+
+- Remove accidental `require` of debugger
+
+## 0.1.0
+
+Initial release

data/CONTRIBUTING.md

@@ -18,7 +18,7 @@ To test a change, in the first tab I make a WIP commit then in the second tab I
 ```
 rm -rf /Users/jared/git/banana/.bundle/plugin
 bundler plugin install bundler-why \
-  --git file:///Users/jared/git/bundler-why \
+  --git file:///Users/jared/git/bundler-why --branch trunk \
   --verbose --retry=1
 bundle why tzinfo
 ```

data/Gemfile

@@ -1,7 +1,9 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bundler-why.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "minitest", "~> 5.0"
+gem 'minitest', '~> 5.0'
+gem 'rubocop', '~> 0.86.0'

data/LICENSE.md

@@ -12,7 +12,7 @@ We build software to further this vision of a just world, or at the very least,
 
 **Terms**
 
-*Copyright* (c) *(year)* *(owner)*. All rights reserved.
+*Copyright* (c) *(2020)* *(Jared Beck)*. All rights reserved.
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

data/README.md

@@ -12,7 +12,7 @@ business_time -> tzinfo
 
 ## License
 
-[Do No Harm License][LICENSE.md]
+[Do No Harm License](LICENSE.md)
 
 By using this software you accept the terms of the license.
 

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "bundler/why"
+require 'bundler/setup'
+require 'bundler/why'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "bundler/why"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/test

@@ -1,3 +1,4 @@
 #!/usr/bin/env bash
 
+bundle exec rubocop
 ruby -I test test/bundler/why_test.rb

data/bundler-why.gemspec

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 require_relative 'lib/bundler/why/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "bundler-why"
+  spec.name = 'bundler-why'
   spec.licenses = ['Nonstandard']
   spec.version = ::Bundler::Why.gem_version.to_s
-  spec.authors = ["Jared Beck"]
-  spec.email = ["jared@jaredbeck.com"]
+  spec.authors = ['Jared Beck']
+  spec.email = ['jared@jaredbeck.com']
   spec.summary = 'Explains the presence of a dependency.'
   spec.homepage = 'https://github.com/jaredbeck/bundler-why'
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.
       split("\x0").
       reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

data/lib/bundler/why.rb

@@ -1,5 +1,7 @@
-require "bundler/why/command"
-require "bundler/why/version"
+# frozen_string_literal: true
+
+require 'bundler/why/command'
+require 'bundler/why/version'
 
 module Bundler
   module Why

data/lib/bundler/why/command.rb

@@ -1,12 +1,12 @@
-require 'byebug'
-$stdout.sync = true
+# frozen_string_literal: true
 
 module Bundler
   module Why
+    # Registers and defines the `why` command.
     class Command < ::Bundler::Plugin::API
-      command "why"
+      command 'why'
 
-      def exec(command, args)
+      def exec(_command, args)
         if args.length == 1
           why(args.first)
         else
@@ -16,18 +16,11 @@ module Bundler
 
       private
 
-      # `Bundler.load` is a memoized method, so it's OK if we call it a few
-      # times.
-      # @return Bundler::Runtime
-      def runtime
-        Bundler.load
-      end
-
       # @param spec_set Bundler::SpecSet
       # @param gem_name String
       # @return Bundler::StubSpecification
       def find_one_spec_in_set(spec_set, gem_name)
-        specs = runtime.specs[gem_name]
+        specs = spec_set[gem_name]
         if specs.length == 1
           specs.first
         else
@@ -47,6 +40,7 @@ module Bundler
       # @param gem_name String
       # @void
       def why(gem_name)
+        runtime = Bundler.load
         spec_set = runtime.specs
         spec = find_one_spec_in_set(spec_set, gem_name)
         traverse(spec_set, spec)

data/lib/bundler/why/version.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Bundler
+  # :nodoc:
   module Why
     def self.gem_version
-      ::Gem::Version.new('0.1.0')
+      ::Gem::Version.new('0.1.1')
     end
   end
 end

data/plugins.rb

@@ -1 +1,3 @@
-require "bundler/why"
+# frozen_string_literal: true
+
+require 'bundler/why'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bundler-why
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jared Beck
@@ -18,8 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.md